|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.common.binding.decoding.impl.AbstractMessageDecoder<RequestType>
RequestType
- request type that will be decodedpublic abstract class AbstractMessageDecoder<RequestType extends javax.servlet.ServletRequest>
Base class for message decoder handling much of the boilerplate code.
Constructor Summary | |
---|---|
AbstractMessageDecoder()
|
Method Summary | |
---|---|
protected void |
evaluateSecurityPolicy(XMLObject decodedMessage)
Evaluates the registered security policy, if there is one, against the provided request and message. |
MetadataProvider |
getMetadataProvider()
Gets the metadata provider used to lookup information about the issuer. |
ParserPool |
getParserPool()
Gets the pool of parsers to use to parse XML. |
RequestType |
getRequest()
Gets the request to decode. |
SAMLObject |
getSAMLMessage()
Gets the SAML message that was received and decoded. |
SAMLSecurityPolicy |
getSecurityPolicy()
Gets the security policy to apply to the request and its payload. |
TrustEngine |
getTrustEngine()
Gets the trust engine used to verify the credentials of a request. |
void |
setMetadataProvider(MetadataProvider newProvider)
Sets the metadata provider used to lookup information about the issuer. |
void |
setParserPool(ParserPool pool)
Sets the pool of parsers to use to parse XML. |
void |
setRequest(RequestType newRequest)
Sets the request to decode. |
protected void |
setSAMLMessage(SAMLObject newMessage)
Sets the decoded SAML message. |
void |
setSecurityPolicy(SAMLSecurityPolicy policy)
Sets the security policy to apply to the request and its payload. |
void |
setTrustEngine(TrustEngine newEngine)
Sets the the trust engine used to verify the credentials of a request. |
protected XMLObject |
unmarshallMessage(java.io.InputStream samlMessage)
Parses the incoming message into a DOM and then unmarshalls it into a SAMLObject. |
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.decoding.MessageDecoder |
---|
decode, getBindingURI |
Constructor Detail |
---|
public AbstractMessageDecoder()
Method Detail |
---|
public ParserPool getParserPool()
public void setParserPool(ParserPool pool)
pool
- pool of parsers to use to parse XMLpublic MetadataProvider getMetadataProvider()
getMetadataProvider
in interface MessageDecoder<RequestType extends javax.servlet.ServletRequest>
public RequestType getRequest()
getRequest
in interface MessageDecoder<RequestType extends javax.servlet.ServletRequest>
public SAMLObject getSAMLMessage()
getSAMLMessage
in interface MessageDecoder<RequestType extends javax.servlet.ServletRequest>
public SAMLSecurityPolicy getSecurityPolicy()
getSecurityPolicy
in interface MessageDecoder<RequestType extends javax.servlet.ServletRequest>
public TrustEngine getTrustEngine()
getTrustEngine
in interface MessageDecoder<RequestType extends javax.servlet.ServletRequest>
public void setMetadataProvider(MetadataProvider newProvider)
setMetadataProvider
in interface MessageDecoder<RequestType extends javax.servlet.ServletRequest>
newProvider
- metadata provider used to lookup information about the issuerpublic void setRequest(RequestType newRequest)
setRequest
in interface MessageDecoder<RequestType extends javax.servlet.ServletRequest>
newRequest
- request to decodeprotected void setSAMLMessage(SAMLObject newMessage)
newMessage
- decoded SAML messagepublic void setSecurityPolicy(SAMLSecurityPolicy policy)
setSecurityPolicy
in interface MessageDecoder<RequestType extends javax.servlet.ServletRequest>
policy
- security policy to apply to the request and its payloadpublic void setTrustEngine(TrustEngine newEngine)
setTrustEngine
in interface MessageDecoder<RequestType extends javax.servlet.ServletRequest>
newEngine
- the trust engine used to verify the credentials of a requestprotected XMLObject unmarshallMessage(java.io.InputStream samlMessage) throws BindingException
samlMessage
- message to unmarshall
BindingException
- thrown if the incoming XML can not be parsed and unmarshalledprotected void evaluateSecurityPolicy(XMLObject decodedMessage) throws SecurityPolicyException
decodedMessage
- message to evaluate the policy against
SecurityPolicyException
- thrown if the given request/message do not meet the requirements of the security
policy
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |