com.webmethods.caf.wsclient.session
Interface IWSClientSession

All Known Implementing Classes:

WSClientSession

public interface IWSClientSession

An interface that holds the minimum information for the IWSClientSessionManager to manage a session

Method Summary

AuthCredentials	getAuthCredentials() Get the AuthCredentials used by the session to authenicate web service requests.
String	getHostURL() Get the configured endPoint for this session (and ProxyContext)
String	getID() The unique ID that describes this session
ProxyContext	getProxyContext() Get the context created for this Session.
ClientCookie[]	getSessionCookies() Get any the ClientCookie[] associated with this session
boolean	isBusy() Is this session currently servicing a web service request
boolean	isExpired() Has this session been flagged for expiration
void	setAuthCredentials(AuthCredentials authCredentials) Set the AuthCredentials of the session
void	setBusy(boolean busy) Mark this session as busy and not available to handle another request
void	setExpired(boolean expired) Mark this session as expired
void	setSessionCookies(ClientCookie[] m_sessionCookies) Set the session's client cookies

Method Detail

getID

String getID()

The unique ID that describes this session

getProxyContext

ProxyContext getProxyContext()

Get the context created for this Session. Every time this is called, it will create a new proxy context

setAuthCredentials

void setAuthCredentials(AuthCredentials authCredentials)

Set the AuthCredentials of the session

Parameters:

{@link - AuthCredentials} object used to authenticate the web service request.

getAuthCredentials

AuthCredentials getAuthCredentials()

Get the AuthCredentials used by the session to authenicate web service requests.

getHostURL

String getHostURL()

Get the configured endPoint for this session (and ProxyContext)

Returns:

the endpoint URL of the web service to invoke

isExpired

boolean isExpired()

Has this session been flagged for expiration

Returns:

true if the session has expired

setExpired

void setExpired(boolean expired)

Mark this session as expired

Parameters:

expired - true if this session is no longer valid

isBusy

boolean isBusy()

Is this session currently servicing a web service request

Returns:

true if the session is busy and is not available to handle another request

setBusy

void setBusy(boolean busy)

Mark this session as busy and not available to handle another request

Parameters:

busy - true if the session is busy

getSessionCookies

ClientCookie[] getSessionCookies()

Get any the ClientCookie[] associated with this session

Returns:

ClientCookie[] or null

setSessionCookies

void setSessionCookies(ClientCookie[] m_sessionCookies)

Set the session's client cookies

Parameters:

m_sessionCookies - - an array of ClientCookie objects