|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ResponseType
- the type of response the message is encoded topublic interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
Encodes a SAML message in a binding specific manner. A given encoder instance need not be thread-safe or reusable. The process of encoding a message may change some of the properties set on this encoder. For example, a message may be required to be signed in a specific manner, so prior to the encoding the message may not be signed while afterwords it may be.
Method Summary | |
---|---|
void |
encode()
Encode the SAML message in the binding specific manner. |
java.lang.String |
getBindingURI()
Gets the binding URI supported by this encoder. |
java.lang.String |
getIssuer()
Gets the issuer of the message. |
MetadataProvider |
getMetadataProvider()
Gets the metadata provider that can be used to look up information about the relying party. |
EntityDescriptor |
getRelyingParty()
Gets the relying party the message will be encoded for. |
Endpoint |
getRelyingPartyEndpoint()
Gets the endpoint to which the message will be sent. |
RoleDescriptor |
getRelyingPartyRole()
Gets the role of the relying party the message will be encoded for. |
ResponseType |
getResponse()
Sets the response to use during the encoding process. |
SAMLObject |
getSamlMessage()
Gets the SAML message that will be encoded and sent to the relying party. |
Credential |
getSigningCredential()
Gets the credential that should be used to sign the message. |
void |
setIssuer(java.lang.String issuer)
Sets the issuer of the message. |
void |
setMetadataProvider(MetadataProvider metadatProvider)
Sets the metadata provider that can be used to look up information about the relying party. |
void |
setRelyingParty(EntityDescriptor relyingParty)
Sets relying party the message will be encoded for. |
void |
setRelyingPartyEndpoint(Endpoint endpoint)
Sets the endpoint to which the message will be sent. |
void |
setRelyingPartyRole(RoleDescriptor relyingPartyRole)
Sets the role of the relying party the message will be encoded for. |
void |
setResponse(ResponseType response)
Sets the response to use during the encoding process. |
void |
setSamlMessage(SAMLObject samlMessage)
Sets the SAML message that will be encoded and sent to the relying party. |
void |
setSigningCredential(Credential credential)
Sets the credential that should be used to sign the message. |
Method Detail |
---|
java.lang.String getBindingURI()
MetadataProvider getMetadataProvider()
void setMetadataProvider(MetadataProvider metadatProvider)
metadatProvider
- provider that can be used to look up information about the relying party, may not be nulljava.lang.String getIssuer()
void setIssuer(java.lang.String issuer)
issuer
- issuer of the messageEntityDescriptor getRelyingParty()
void setRelyingParty(EntityDescriptor relyingParty)
relyingParty
- relying party the message will be encoded for, may not be nullRoleDescriptor getRelyingPartyRole()
void setRelyingPartyRole(RoleDescriptor relyingPartyRole)
relyingPartyRole
- role of the relying party the message will be encoded forEndpoint getRelyingPartyEndpoint()
void setRelyingPartyEndpoint(Endpoint endpoint)
endpoint
- endpoint to which the message will be sentSAMLObject getSamlMessage()
void setSamlMessage(SAMLObject samlMessage)
samlMessage
- the SAML message to encode, may not be nullCredential getSigningCredential()
void setSigningCredential(Credential credential)
credential
- credential that should be used to sign the messageResponseType getResponse()
void setResponse(ResponseType response)
response
- the response to use during encodingvoid encode() throws BindingException
BindingException
- thrown if the problem can not be encoded
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |