com.aspc.Soap

Class SoapClient

java.lang.Object

com.supertracker.Servlets.HttpClient

com.aspc.Soap.SoapClient

All Implemented Interfaces:

ServerProcess

Direct Known Subclasses:

SoapDOMClient

public class SoapClient
extends HttpClient

SoapClient is the Servlet client
THREAD MODE: MULTI-THREADED

Since:

March 15, 2003, 10:56 PM

Author:

Nigel Leck

Field Summary

Fields inherited from class com.supertracker.Servlets.HttpClient

BY_PASS_CHECKS, CONTENT_ENCODING_BASE64, CONTENT_ENCODING_DEFLATE, CONTENT_ENCODING_GZIP, cookiesWritten, currentDB, currentDS, dTable, HEADER_ACCEPT_ENCODING, HEADER_CONTENT_ENCODING, HEADER_CONTENT_TRANSFER_ENCODING, request, servletPath, X_FORWARDED_PROTO

Constructor Summary

Constructors

Constructor and Description
SoapClient(HttpServletRequest request) Creates new SoapClient

Method Summary

Modifier and Type	Method and Description
void	checkSession()
VirtualDB	getBaseDatabase()
java.lang.String	getHttpSessionId()
Login	getLogin() Get's the client's login
java.lang.String	getMethod()
protected java.lang.String	getRawParameter(java.lang.String name, java.lang.String defaultValue) Gets the parameter value
ReadOnlyDataSource	getReadOnlyDataSource() get the cached readonly data source
Session	getSession()
java.lang.Object	getSessionAttribute(java.lang.String name, java.lang.Object defaultAttribute) No HTTP Session for SOAP
boolean	isPubilcAllowed() are public logins allowed ?
Session	login(java.lang.String userName, java.lang.String password, LoginContext loginContext, java.lang.String signature) This function logs the user in based on the input parameters.
void	logout() Logout the client's session
void	sendDocument(org.w3c.dom.Document doc, HttpServletResponse response, java.lang.String contentEncoding)
void	setAllowPublic(boolean flag) allow public logins

Methods inherited from class com.supertracker.Servlets.HttpClient

clearParameters, clickedButton, currentClient, dispose, getBrowser, getCallURL, getCallURL, getCookies, getCookieValue, getDatabase, getDefaultSignature, getDS, getFullRequestString, getHeader, getHostname, getHttpSession, getJoinRequestCount, getLayerId, getMessageID, getNewPage, getParameter, getParameter, getParameterInt, getParameterLong, getParameterNames, getPathInfo, getProtocolAndHostname, getReportMaxSortRows, getRequest, getRequestString, getRequestText, getServletPath, getSessionAttribute, getStartAfterFullLoadTime, getStartTime, getUniqueRequestCount, hasCookie, hasParameter, isDisposed, isHTTPS, isRestThrottleSupported, isSecure, isUseCapitalParamNames, joinCommand, logException, logTime, makeServerName, makeThreadName, paused, putCookie, removeCookie, restoreClient, resumed, sendData, setDS, setParameter, setPathInfo, setServletPath, setSessionAttribute, setUseCapitalParamNames, terminated, toString, writtenCookies

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SoapClient

public SoapClient(HttpServletRequest request)
           throws java.lang.Exception

Creates new SoapClient

Parameters:

request - The raw HttpRequest

Throws:

java.lang.Exception - a serious problem

Method Detail

sendDocument

public void sendDocument(org.w3c.dom.Document doc,
                         HttpServletResponse response,
                         java.lang.String contentEncoding)
                  throws java.lang.Exception

Parameters:

doc - the document

response -

contentEncoding -

Throws:

java.lang.Exception - a serious problem

getHttpSessionId

public java.lang.String getHttpSessionId()

Specified by:

getHttpSessionId in class HttpClient

Returns:

the value

logout

public void logout()

Logout the client's session

Specified by:

logout in class HttpClient

getLogin

public Login getLogin()

Get's the client's login

Specified by:

getLogin in class HttpClient

Returns:

The login

getSession

@CheckReturnValue
 @Nullable
public Session getSession()

Specified by:

getSession in class HttpClient

Returns:

the value

isPubilcAllowed

public boolean isPubilcAllowed()

are public logins allowed ?

Returns:

true if allowed

setAllowPublic

public void setAllowPublic(boolean flag)

allow public logins

Parameters:

flag - true if allowed

checkSession

public void checkSession()
                  throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

getReadOnlyDataSource

public final ReadOnlyDataSource getReadOnlyDataSource()
                                               throws java.lang.Exception

Description copied from class: HttpClient

get the cached readonly data source

Specified by:

getReadOnlyDataSource in class HttpClient

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getMethod

public java.lang.String getMethod()

Returns:

the value

getSessionAttribute

public java.lang.Object getSessionAttribute(java.lang.String name,
                                            java.lang.Object defaultAttribute)

No HTTP Session for SOAP

Specified by:

getSessionAttribute in class HttpClient

Parameters:

name -

defaultAttribute -

Returns:

the value

getRawParameter

protected java.lang.String getRawParameter(java.lang.String name,
                                           java.lang.String defaultValue)

Description copied from class: HttpClient

Gets the parameter value

Specified by:

getRawParameter in class HttpClient

Parameters:

name -

defaultValue -

Returns:

the value

login

public Session login(java.lang.String userName,
                     java.lang.String password,
                     LoginContext loginContext,
                     java.lang.String signature)
              throws NotFoundException,
                     ExpiredPasswordException,
                     java.lang.Exception

This function logs the user in based on the input parameters. The function does not check the input parameters for validity.

Specified by:

login in class HttpClient

Parameters:

signature -

userName - The user is

password - The password

loginContext - The login context

Returns:

the value

Throws:

NotFoundException - not found

ExpiredPasswordException - expired password

java.lang.Exception - could not log in ( including invalid password)

getBaseDatabase

public VirtualDB getBaseDatabase()
                          throws VirtualDBNotFoundException,
                                 DBVersionException,
                                 VirtualDBExpiredException

Specified by:

getBaseDatabase in class HttpClient

Returns:

the value

Throws:

VirtualDBNotFoundException

DBVersionException

VirtualDBExpiredException