IBM WebSphere Extended Deployment (XD)TM
Release 6.0

com.ibm.wsspi.filter
ProxyServiceContext

All Implemented Interfaces
FilterAttributeBucket


This class has been picked up from the proxy component. Defines a filter's view of all protocol-independent, proxy server-specific extensions to channel framework contexts, including support of a per-flow attribute bucket. This interface is extended by protocol-specific service context interfaces. This class has been picked up from the proxy component.


Method Summary
public  InetAddressgetClientAddr()
           Returns the Internet Protocol (IP) address of the client that sent the flow.
public  intgetClientPort()
           Returns the port number of the client that sent the flow.
public  InetAddressgetLocalAddr()
           Returns the Internet Protocol (IP) address of the proxy server that received the request.
public  intgetLocalPort()
           Returns the proxy server port number that received the request. For HTTP, this means the .
public  booleanresume()
           Resumes processing of this service context after a filter suspended its processing by returning a wait status code.
public  booleanresume(com.ibm.wsspi.filter.DispatchMode)
           Resumes processing of this service context after a filter suspended its processing by returning a wait status code..

Inherited Methods

Methods inherited from com.ibm.wsspi.proxy.filter.FilterAttributeBucket
containsAttribute, getAttribute, getAttributes, removeAttribute, setAttribute

Method Detail

getClientAddr

public InetAddress getClientAddr()
Returns the Internet Protocol (IP) address of the client that sent the flow.


Returns:
     A InetAddress containing the IP address of the client that sent the flow.


getClientPort

public int getClientPort()
Returns the port number of the client that sent the flow.


Returns:
     An integer specifying the port number.


getLocalAddr

public InetAddress getLocalAddr()
Returns the Internet Protocol (IP) address of the proxy server that received the request.


Returns:
     A InetAddress containing the IP address of the server that received the flow.


getLocalPort

public int getLocalPort()
Returns the proxy server port number that received the request. For HTTP, this means the value of the part after the colon in the Host header, if any, or the proxy server port upon which the client connection was accepted.


Returns:
     An integer specifying the port number.


resume

public boolean resume()
Resumes processing of this service context after a filter suspended its processing by returning a wait status code. The service context will resume execution on another thread upon successful dispatch. Upon failure to dispatch to another thread, the service context will be resumed on the current thread.

All protocols do not support wait status codes. This method is effectively a no-op for those protocols and filters that do not support waiting.

Refer to #resume(DispatchMode dispatchMode) for further details.



Returns:
     =true when this service context was suspend; otherwise, =false when this service context was already resumed.


resume

public boolean resume(DispatchMode dispatchMode)
Resumes processing of this service context after a filter suspended its processing by returning a wait status code.

All protocols do not support wait status codes. This method is effectively a no-op for those protocols and filters that do not support waiting.

Parameters:
    dispatchMode - Determines the thread dispatch behavior when resuming the service context. =DispatchMode.CURRENT_THREAD, the service context will be immediately resumed on the current thread. =DispatchMode.ANOTHER_THREAD, the service context will be resumed on another thread upon successful dispatch. Upon failure to dispatch, the service context will be resumed on the current thread. =DispatchMode.DISCARD_ON_ERROR, the service context will be resumed on another thread upon successful dispatch. Upon failure to dispatch, the service context will be discarded and no further execution of the service context will occur. =DispatchMode.DispatchMode.ANOTHER_THREAD_EXPAND resume execution on another thread upon succesful dispatch. If the request queue is full at the time of initial dispatch, it will be expanded and the service context will be dispatched to resume execution. If the expanded request buffer becomes full, execution will resume on the current thread. =DispatchMode.DispatchMode.ANOTHER_THREAD_EXPAND_DISCARD Resume execution on another thread upon succesful dispatch. If the request queue is full at the time of initial dispatch, it will be expanded and the service context will be dispatched to resume execution. If the expanded request buffer becomes full, the service context will be discarded and execution will not resume.


Returns:
     =true when this service context was suspend; otherwise, =false when this service context was already resumed.


IBM WebSphere Extended Deployment (XD)TM
Release 6.0