|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.opensaml.ws.message.encoder.BaseMessageEncoder org.opensaml.saml2.binding.encoding.BaseSAML2MessageEncoder org.opensaml.saml2.binding.encoding.HTTPArtifactEncoder
public class HTTPArtifactEncoder
SAML 2 Artifact Binding encoder, support both HTTP GET and POST.
Field Summary | |
---|---|
private SAMLArtifactMap |
artifactMap
SAML artifact map used to store created artifacts for later retrieval. |
private byte[] |
defaultArtifactType
Default artifact type to use when encoding messages. |
private org.slf4j.Logger |
log
Class logger. |
private boolean |
postEncoding
Whether the POST encoding should be used, instead of GET. |
private org.apache.velocity.app.VelocityEngine |
velocityEngine
Velocity engine used to evaluate the template when performing POST encoding. |
private String |
velocityTemplateId
ID of the velocity template used when performing POST encoding. |
Constructor Summary | |
---|---|
HTTPArtifactEncoder(org.apache.velocity.app.VelocityEngine engine,
String template,
SAMLArtifactMap map)
Constructor. |
Method Summary | |
---|---|
protected AbstractSAML2Artifact |
buildArtifact(SAMLMessageContext artifactContext)
Builds the SAML 2 artifact for the outgoing message. |
protected void |
doEncode(MessageContext messageContext)
|
String |
getBindingURI()
Gets the SAML binding URI supported by this encoder. |
protected void |
getEncode(SAMLMessageContext artifactContext,
HTTPOutTransport outTransport)
Performs HTTP GET based encoding. |
boolean |
isPostEncoding()
Gets whether the encoder will encode the artifact via POST encoding. |
protected void |
postEncode(SAMLMessageContext artifactContext,
HTTPOutTransport outTransport)
Performs HTTP POST based encoding. |
boolean |
providesMessageConfidentiality(MessageContext messageContext)
|
boolean |
providesMessageIntegrity(MessageContext messageContext)
|
void |
setPostEncoding(boolean post)
Sets whether the encoder will encode the artifact via POST encoding. |
Methods inherited from class org.opensaml.saml2.binding.encoding.BaseSAML2MessageEncoder |
---|
checkRelayState, getAllowedURLSchemes, getEndpointURL, setAllowedURLSchemes, setResponseDestination, signMessage |
Methods inherited from class org.opensaml.ws.message.encoder.BaseMessageEncoder |
---|
encode, logEncodedMessage, marshallMessage |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.opensaml.ws.message.encoder.MessageEncoder |
---|
encode |
Field Detail |
---|
private final org.slf4j.Logger log
private boolean postEncoding
private org.apache.velocity.app.VelocityEngine velocityEngine
private String velocityTemplateId
private SAMLArtifactMap artifactMap
private byte[] defaultArtifactType
Constructor Detail |
---|
public HTTPArtifactEncoder(org.apache.velocity.app.VelocityEngine engine, String template, SAMLArtifactMap map)
engine
- velocity engine used to construct the POST formtemplate
- ID of velocity template used to construct the POST formmap
- artifact map used to store artifact/message bindingsMethod Detail |
---|
public String getBindingURI()
public boolean isPostEncoding()
public void setPostEncoding(boolean post)
post
- true if POST encoding will be used, false if GET encoding will be usedpublic boolean providesMessageConfidentiality(MessageContext messageContext) throws MessageEncodingException
MessageEncodingException
public boolean providesMessageIntegrity(MessageContext messageContext) throws MessageEncodingException
MessageEncodingException
protected void doEncode(MessageContext messageContext) throws MessageEncodingException
doEncode
in class BaseMessageEncoder
MessageEncodingException
protected void postEncode(SAMLMessageContext artifactContext, HTTPOutTransport outTransport) throws MessageEncodingException
artifactContext
- current request contextoutTransport
- outbound HTTP transport
MessageEncodingException
- thrown if there is a problem POST encoding the artifactprotected void getEncode(SAMLMessageContext artifactContext, HTTPOutTransport outTransport) throws MessageEncodingException
artifactContext
- current request contextoutTransport
- outbound HTTP transport
MessageEncodingException
- thrown if there is a problem GET encoding the artifactprotected AbstractSAML2Artifact buildArtifact(SAMLMessageContext artifactContext) throws MessageEncodingException
artifactContext
- current request context
MessageEncodingException
- thrown if the artifact can not be created
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |