|
|||||||||
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.saml1.binding.encoding.HTTPPostEncoder
public class HTTPPostEncoder
SAML 1.X HTTP POST message encoder.
Field Summary | |
---|---|
static java.lang.String |
BINDING_URI
Binding URI. |
Constructor Summary | |
---|---|
HTTPPostEncoder()
|
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. |
protected java.lang.String |
getEndpointURL()
Gets the response URL from the relying party endpoint. |
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.io.Writer responseWriter,
java.lang.String message)
POST encodes the SAML message. |
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. |
protected void |
signMessage()
Signs the given SAML message if it a SignableSAMLObject and this encoder has signing credentials. |
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 |
Field Detail |
---|
public static final java.lang.String BINDING_URI
Constructor Detail |
---|
public HTTPPostEncoder()
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 void encode() throws BindingException
BindingException
- thrown if the problem can not be encodedprotected void postEncode(java.io.Writer responseWriter, java.lang.String message) throws BindingException
responseWriter
- writer to write the encoded message tomessage
- base64 encoded SAML message
BindingException
- thrown if the message can not be written to the writerprotected java.lang.String getEndpointURL() throws BindingException
Response
and the relying
party endpoint contains a response location then that location is returned otherwise the normal endpoint location
is returned.
BindingException
- throw if no relying party endpoint is availableprotected void signMessage()
SignableSAMLObject
and this encoder has signing credentials.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |