|
|||||||||
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<javax.servlet.http.HttpServletResponse>
org.opensaml.common.binding.encoding.impl.AbstractHTTPMessageEncoder
org.opensaml.saml2.binding.encoding.AbstractSAML2HTTPMessageEncoder
org.opensaml.saml2.binding.encoding.HTTPArtifactEncoder
public class HTTPArtifactEncoder
SAML 2 Artifact Binding encoder, support both HTTP GET and POST.
Nested Class Summary | |
---|---|
static class |
HTTPArtifactEncoder.ENCODING_METHOD
Artifact encoding methods. |
Constructor Summary | |
---|---|
HTTPArtifactEncoder()
|
Method Summary | |
---|---|
void |
encode()
Encode the SAML message in the binding specific manner. |
protected void |
generateArtifact()
Generates the artifact to use and maps the given SAML message to it. |
SAMLArtifact |
getArtifact()
Gets the artifact created for the given SAML message. |
SAMLArtifactFactory |
getArtifactFactory()
Gets the artifact factory used to create artifacts for this encoder. |
SAMLArtifactMap |
getArtifactMap()
Gets the artifact map used to map artifacts and messages. |
byte[] |
getArtifactType()
Gets the type of artifact this encoder will use. |
java.lang.String |
getBindingURI()
Gets the binding URI supported by this encoder. |
protected void |
getEncode(java.lang.String artifactString)
Performs HTTP GET based econding. |
HTTPArtifactEncoder.ENCODING_METHOD |
getEncodingMethod()
Gets the HTTP submit method to use. |
org.apache.velocity.app.VelocityEngine |
getVelocityEngine()
Gets the velocity engine used to evaluate the template when performing POST encoding. |
java.lang.String |
getVelocityTemplateId()
Gets the ID of the velocity template used for POST encoding. |
protected void |
postEncode(java.lang.String artifactString)
Performs HTTP POST based encoding. |
void |
setArtifactFactory(SAMLArtifactFactory factory)
Sets the artifact factory used to create artifacts for this encoder. |
void |
setArtifactMap(SAMLArtifactMap map)
Sets the artifact map used to map artifacts and messages. |
void |
setArtifactType(byte[] type)
Sets the type of artifact this encoder will use. |
void |
setEncodingMethod(HTTPArtifactEncoder.ENCODING_METHOD method)
Sets the HTTP submit method to use. |
void |
setVelocityEngine(org.apache.velocity.app.VelocityEngine engine)
Sets the velocity engine used to evaluate the template when performing POST encoding. |
void |
setVelocityTemplateId(java.lang.String id)
Sets the ID of the velocity template used for POST encoding. |
Methods inherited from class org.opensaml.saml2.binding.encoding.AbstractSAML2HTTPMessageEncoder |
---|
checkRelayState, getEndpointURL, signMessage |
Methods inherited from class org.opensaml.common.binding.encoding.impl.AbstractHTTPMessageEncoder |
---|
getBase64EncodedMessage, getEncodeRelayState, getRelayState, initializeResponse, setRelayState |
Methods inherited from class org.opensaml.common.binding.encoding.impl.AbstractMessageEncoder |
---|
getIssuer, getMetadataProvider, getRelyingParty, getRelyingPartyEndpoint, getRelyingPartyRole, getResponse, getSamlMessage, getSigningCredential, marshallMessage, setIssuer, setMetadataProvider, setRelyingParty, setRelyingPartyEndpoint, setRelyingPartyRole, setResponse, setSamlMessage, setSigningCredential |
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 |
---|
getIssuer, getMetadataProvider, getRelyingParty, getRelyingPartyEndpoint, getRelyingPartyRole, getResponse, getSamlMessage, getSigningCredential, setIssuer, setMetadataProvider, setRelyingParty, setRelyingPartyEndpoint, setRelyingPartyRole, setResponse, setSamlMessage, setSigningCredential |
Constructor Detail |
---|
public HTTPArtifactEncoder()
Method Detail |
---|
public java.lang.String getBindingURI()
public org.apache.velocity.app.VelocityEngine getVelocityEngine()
public void setVelocityEngine(org.apache.velocity.app.VelocityEngine engine)
engine
- velocity engine used to evaluate the template when performing POST encodingpublic java.lang.String getVelocityTemplateId()
public void setVelocityTemplateId(java.lang.String id)
id
- ID of the velocity template used for POST encodingpublic HTTPArtifactEncoder.ENCODING_METHOD getEncodingMethod()
public void setEncodingMethod(HTTPArtifactEncoder.ENCODING_METHOD method)
method
- HTTP submit method to usepublic SAMLArtifactFactory getArtifactFactory()
public void setArtifactFactory(SAMLArtifactFactory factory)
factory
- artifact factory used to create artifacts for this encoderpublic SAMLArtifactMap getArtifactMap()
public void setArtifactMap(SAMLArtifactMap map)
map
- artifact map used to map artifacts and messagespublic byte[] getArtifactType()
public void setArtifactType(byte[] type)
type
- type of artifact this encoder will usepublic SAMLArtifact getArtifact()
public void encode() throws BindingException
BindingException
- thrown if the problem can not be encodedprotected void postEncode(java.lang.String artifactString) throws BindingException
artifactString
- the base64 encoded artifact
BindingException
- thrown if there is a problem invoking the velocity template to create the formprotected void getEncode(java.lang.String artifactString) throws BindingException
artifactString
- the base64 encoded artifact
BindingException
- thrown if there is a problem redirecting the responseprotected void generateArtifact() throws BindingException
BindingException
- thrown if the artifact can not be created
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |