|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.common.binding.encoding.impl.AbstractMessageEncoder<ResponseType>
ResponseType
- the type of response the message is encoded topublic abstract class AbstractMessageEncoder<ResponseType extends javax.servlet.ServletResponse>
Base class handling boilerplate code for message encoders.
Constructor Summary | |
---|---|
AbstractMessageEncoder()
|
Method Summary | |
---|---|
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. |
protected java.lang.String |
marshallMessage(XMLObject message)
Marshalls an XML message and writes the element to a string using UTF-8 encoding. |
void |
setIssuer(java.lang.String id)
Sets the issuer of the message. |
void |
setMetadataProvider(MetadataProvider provider)
Sets the metadata provider that can be used to look up information about the relying party. |
void |
setRelyingParty(EntityDescriptor entity)
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 role)
Sets the role of the relying party the message will be encoded for. |
void |
setResponse(ResponseType rpResponse)
Sets the response to use during the encoding process. |
void |
setSamlMessage(SAMLObject message)
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.opensaml.common.binding.encoding.MessageEncoder |
---|
encode, getBindingURI |
Constructor Detail |
---|
public AbstractMessageEncoder()
Method Detail |
---|
public MetadataProvider getMetadataProvider()
getMetadataProvider
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
public void setMetadataProvider(MetadataProvider provider)
setMetadataProvider
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
provider
- provider that can be used to look up information about the relying party, may not be nullpublic java.lang.String getIssuer()
getIssuer
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
public void setIssuer(java.lang.String id)
setIssuer
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
id
- issuer of the messagepublic EntityDescriptor getRelyingParty()
getRelyingParty
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
public void setRelyingParty(EntityDescriptor entity)
setRelyingParty
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
entity
- relying party the message will be encoded for, may not be nullpublic Endpoint getRelyingPartyEndpoint()
getRelyingPartyEndpoint
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
public void setRelyingPartyEndpoint(Endpoint endpoint)
setRelyingPartyEndpoint
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
endpoint
- endpoint to which the message will be sentpublic RoleDescriptor getRelyingPartyRole()
getRelyingPartyRole
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
public void setRelyingPartyRole(RoleDescriptor role)
setRelyingPartyRole
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
role
- role of the relying party the message will be encoded forpublic SAMLObject getSamlMessage()
getSamlMessage
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
public void setSamlMessage(SAMLObject message)
setSamlMessage
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
message
- the SAML message to encode, may not be nullpublic Credential getSigningCredential()
getSigningCredential
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
public void setSigningCredential(Credential credential)
setSigningCredential
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
credential
- credential that should be used to sign the messagepublic ResponseType getResponse()
getResponse
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
public void setResponse(ResponseType rpResponse)
setResponse
in interface MessageEncoder<ResponseType extends javax.servlet.ServletResponse>
rpResponse
- the response to use during encodingprotected java.lang.String marshallMessage(XMLObject message) throws BindingException
message
- the message to marshall
BindingException
- thrown if the message can not be marshalled
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |