Interface STSResponse
-
public interface STSResponse
Used to communicate all the response data to be sent back to the client.
STSResponse implementations allow the modification of member data.- Version:
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
STSResponse_java_copyright
static java.lang.String
STSResponse_java_sourceCodeID
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RequestSecurityTokenResponse
addRequestSecurityTokenResponse()
Creates a new WS-TrustRequestedSecurityTokenResponse
object with the side effect that aRequestSecurityTokenResponseCollection
is created.RequestSecurityTokenResponse
getRequestSecurityTokenResponse()
Returns the WS-TrustRequestedSecurityTokenResponse
object.RequestSecurityTokenResponseCollection
getRequestSecurityTokenResponseCollection()
Returns the WS-TrustRequestedSecurityTokenResponseCollection
object or null.org.w3c.dom.Element
getSOAPEnvelope()
Returns the SOAP envelope as aorg.w3c.dom.Element
to be returned to the client in the response, if null, there was not a SOAP envelope present for this response.STSUniversalUser
getSTSUniversalUser()
Returns the currentcom.tivoli.am.fim.trustserver.sts.STSUniversalUser
for the response.
-
-
-
Field Detail
-
STSResponse_java_sourceCodeID
static final java.lang.String STSResponse_java_sourceCodeID
- See Also:
- Constant Field Values
-
STSResponse_java_copyright
static final java.lang.String STSResponse_java_copyright
-
-
Method Detail
-
getSOAPEnvelope
org.w3c.dom.Element getSOAPEnvelope()
Returns the SOAP envelope as aorg.w3c.dom.Element
to be returned to the client in the response, if null, there was not a SOAP envelope present for this response.
This method exposes a leaky abstraction and may return null if the response will not be sent over SOAP. In either case, the response message document should be used if the requirement is to create an element in the same response document.- Returns:
- a
org.w3c.dom.Element
of the SOAP envelope
-
getRequestSecurityTokenResponse
RequestSecurityTokenResponse getRequestSecurityTokenResponse()
Returns the WS-TrustRequestedSecurityTokenResponse
object. This method never returns null.- Returns:
- the
RequestedSecurityTokenResponse
object
-
getRequestSecurityTokenResponseCollection
RequestSecurityTokenResponseCollection getRequestSecurityTokenResponseCollection()
Returns the WS-TrustRequestedSecurityTokenResponseCollection
object or null. To ensure a non-null result use theaddRequestSecurityTokenResponse
method before invoking this method.- Returns:
- the
RequestedSecurityTokenResponseCollection
object
-
addRequestSecurityTokenResponse
RequestSecurityTokenResponse addRequestSecurityTokenResponse()
Creates a new WS-TrustRequestedSecurityTokenResponse
object with the side effect that aRequestSecurityTokenResponseCollection
is created. The result is that there will be at least 2RequestedSecurityTokenResponse
objects: the default plus those added by this method.- Returns:
- the
RequestedSecurityTokenResponse
object
-
getSTSUniversalUser
STSUniversalUser getSTSUniversalUser()
Returns the currentcom.tivoli.am.fim.trustserver.sts.STSUniversalUser
for the response.- Returns:
- a
com.tivoli.am.fim.trustserver.sts.STSUniversalUser
for the current response.
-
-