All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class oracle.soap.server.UserContext

java.lang.Object
   |
   +----oracle.soap.server.UserContext

public class UserContext

extends Object

UserContext defines the user context for a SOAP service request. Several attributes are pre-defined, and set and get methods are provided for those. In addition, the provider may define additional attributes using getAttribute and setAttribute.

Note that the HttpServlet and HttpSession do not really belong here, but they are required by the JavaProvider.

UserContext()

Default constructor.

getAttribute(String)

Returns the attribute with the given name, or null if there is no attribute by that name.

getAttributeNames()

Returns an Enumeration containing the attribute names available within this SOAP context.

getCertificate()

Returns the user certificate.

getHttpServlet()

Returns the HTTP servlet.

getHttpSession()

Returns the HTTP session.

getRemoteAddress()

Returns the Internet Protocol (IP) address of the client that sent the request.

getRemoteHost()

Returns the host name of the client that sent the request.

getRequestURI()

Returns the URI of the request.

getSecureChannel()

Returns an indication whether the channel is secure.

getUsername()

Returns the protocol-specific username.

removeAttribute(String)

Removes the attribute with the given name from the context.

setAttribute(String, Object)

Binds an object to a given attribute name in this SOAP context.

setCertificate(Object)

Set the user certificate.

setHttpServlet(HttpServlet)

Set the HTTP servlet.

setHttpSession(HttpSession)

Set the HTTP session.

setRemoteAddress(String)

Set the remote IP address of the client

setRemoteHost(String)

Set the host name of the client making the SOAP request

setRequestURI(String)

Set the URI of the request.

setSecureChannel(boolean)

Set the indicator of whether the channel is secure.

setUsername(String)

Set the protocol-specific username.

 public UserContext()

Default constructor.

 public String getRequestURI()

Returns the URI of the request.

Returns:

the URI of the request.

 public void setRequestURI(String uri)

Set the URI of the request.

Parameters:

uri - Request URI

 public Object getCertificate()

Returns the user certificate.

Returns:

The user certificate for the user making SOAP request, or null if this attribute is not set.

 public void setCertificate(Object certificate)

Set the user certificate.

Parameters:

certificate - The user certificate for the user making the SOAP request.

 public HttpServlet getHttpServlet()

Returns the HTTP servlet.

Returns:

The HttpServlet that is processing the SOAP request, or null if the servlet attribute is not set.

 public void setHttpServlet(HttpServlet servlet)

Set the HTTP servlet.

Parameters:

servlet - The HttpServlet that is processing the SOAP request.

 public HttpSession getHttpSession()

Returns the HTTP session.

Returns:

The HttpSession for the SOAP request, or null if the session attribute is not set.

 public void setHttpSession(HttpSession session)

Set the HTTP session.

Parameters:

servlet - The HttpSession for the SOAP request.

 public String getRemoteAddress()

Returns the Internet Protocol (IP) address of the client that sent the request.

Returns:

The remote client's IP address.

 public void setRemoteAddress(String remoteAddress)

Set the remote IP address of the client

Parameters:

remoteAddress - The IP address of the client making the SOAP request.

 public String getRemoteHost()

Returns the host name of the client that sent the request.

Returns:

The remote client's host name.

 public void setRemoteHost(String remoteHost)

Set the host name of the client making the SOAP request

Parameters:

remoteHost - The host name of the client making the SOAP request.

 public boolean getSecureChannel()

Returns an indication whether the channel is secure.

Returns:

true if the channel is secure, else false.

 public void setSecureChannel(boolean secureChannel)

Set the indicator of whether the channel is secure.

Parameters:

secureChannel - true if the channel is secure, else false.

 public String getUsername()

Returns the protocol-specific username.

Returns:

The protocol-specific username for the SOAP request, or null if this attribute is not set.

 public void setUsername(String username)

Set the protocol-specific username.

Parameters:

username - The protocol-specific username for the SOAP request.

 public Object getAttribute(String name)

Returns the attribute with the given name, or null if there is no attribute by that name.

Parameters:

name - A String specifying the name of the attribute.

Returns:

An Object containing the value of the attribute, or null if no attribute exists matching the given name.

See Also:

getAttributeNames

 public Enumeration getAttributeNames()

Returns an Enumeration containing the attribute names available within this SOAP context.

Returns:

An Enumeration of attribute names.

See Also:

getAttribute

 public void setAttribute(String name,
                          Object object)

Binds an object to a given attribute name in this SOAP context. If the name specified is already used for an attribute, this method will remove the old attribute and bind the name to the new attribute. Neither the name nor the object may be null.

Parameters:

name - A non-null String specifying the name of the attribute.

object - An non-null Object representing the attribute to be bound.

 public void removeAttribute(String name)

Removes the attribute with the given name from the context. After removal, subsequent calls to getAttribute(java.lang.String) to retrieve the attribute's value will return null.

Parameters:

name - A String specifying the name of the attribute to be removed.

object - An Object representing the attribute to be bound.

All Packages  Class Hierarchy  This Package  Previous  Next  Index