public interface STSRequest
STSRequest
object encapsulates information specific to the current request
including data from the requestor via the RequestSecurityToken
.
In addition, this object provides:
STSSession
object which can be used to cache/store objects (like nonces) across multiple requests. Modifier and Type | Field and Description |
---|---|
static java.lang.String |
STSRequest_java_copyright |
static java.lang.String |
STSRequest_java_sourceCodeID |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getAttribute(java.lang.String name)
Returns the value of the named attribute as an Object, or null if no
attribute of the given name exists.
|
java.util.Iterator |
getAttributeNames()
Returns a
java.util.Iterator containing the names of the attributes available
to this request. |
java.lang.String |
getAuditTrailID()
Get the Audit trail ID
This ID should be used on all audit related logging
so that audit records for a request may be correlated across
different logging destinations and sources.
|
STSGroupMembership |
getRequestGroupMembership()
Get the instance of the group membership appropriate for the current
request to use as configuration to fulfill the request.
|
RequestSecurityToken |
getRequestSecurityToken()
Returns the WS-Trust RequestSecurityToken as a
com.tivoli.am.fim.trustserver.types.RequestSecurityToken object. |
java.lang.Object |
getServiceHandle(java.lang.String serviceId)
Returns a Service handle that belongs to the servideId specified.
|
org.w3c.dom.Element |
getSOAPEnvelope()
Returns the SOAP envelop as a
org.w3c.dom.Element sent in the client's
request, if any. |
STSSession |
getSTSSession()
Returns a session object to add attribute values that are maintained
across multiple requests.
|
org.w3c.dom.Element |
getWsTrustMsg()
Returns the WS-Trust message as a
org.w3c.dom.Element sent in the client's
request, if any. |
void |
setAttribute(java.lang.String name,
java.lang.Object value)
Stores an attribute in this request.
|
static final java.lang.String STSRequest_java_sourceCodeID
static final java.lang.String STSRequest_java_copyright
STSSession getSTSSession()
STSSession
objectorg.w3c.dom.Element getSOAPEnvelope()
org.w3c.dom.Element
sent in the client's
request, if any.
This method exposes a leaky abstraction, and may not be available if the
request was not sent via SOAP. It is recommended that this method be used only if
it can be guaranteed that the request will be sent via SOAP.org.w3c.dom.Element
of the SOAP envelope that was sent in the
client's request or null.org.w3c.dom.Element getWsTrustMsg()
org.w3c.dom.Element
sent in the client's
request, if any. It must be the original unchanged DOM element.
This method exposes a leaky abstraction, and may not be available if the
request was not sent via SOAP. It is recommended that this method be used only if
it can be guaranteed that the request will be sent via SOAP.org.w3c.dom.Element
of the SOAP envelope that was sent in the
client's request or null.RequestSecurityToken getRequestSecurityToken()
com.tivoli.am.fim.trustserver.types.RequestSecurityToken
object.RequestSecurityToken
included with the request.java.lang.Object getAttribute(java.lang.String name)
name
- a String specifying the name of the attribute.java.util.Iterator getAttributeNames()
java.util.Iterator
containing the names of the attributes available
to this request. This method returns an empty java.util.Iterator
if the request
has no attributes available to it.java.util.Interator
of strings containing the names of the request's
attributes.void setAttribute(java.lang.String name, java.lang.Object value)
name
- a String specifying the name of the attribute.value
- the object to be stored.java.lang.Object getServiceHandle(java.lang.String serviceId)
serviceId
- the name of the service to obtain.STSGroupMembership getRequestGroupMembership()
java.lang.String getAuditTrailID()