SAMLBinding (Nuxeo 2021.1.19 API Documentation)

java.lang.Object
- org.nuxeo.ecm.platform.auth.saml.binding.SAMLBinding

Direct Known Subclasses:

HTTPPostBinding, HTTPRedirectBinding
```
public abstract class SAMLBinding
extends Object
```
Based class for SAML bindings, used for parsing messages.

Since:

6.0

Field Summary

Fields
Modifier and Type	Field	Description
`protected org.opensaml.ws.message.decoder.MessageDecoder`	`decoder`
`protected org.opensaml.ws.message.encoder.MessageEncoder`	`encoder`
`static org.opensaml.common.binding.decoding.URIComparator`	`uriComparator`	URIComparator that strips scheme to avoid issues with reverse proxies

Constructor Summary

Constructors
Constructor Description

SAMLBinding(org.opensaml.ws.message.decoder.MessageDecoder decoder, org.opensaml.ws.message.encoder.MessageEncoder encoder)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`decode(org.opensaml.ws.message.MessageContext context)`	Decodes the given message.
`void`	`encode(org.opensaml.ws.message.MessageContext context)`	Encodes the given message.
`abstract String`	`getBindingURI()`	Returns the URI that identifies this binding.
`abstract boolean`	`supports(org.opensaml.ws.transport.InTransport transport)`	Checks if this binding can be used to extract the message from the request.
`abstract boolean`	`supports(org.opensaml.ws.transport.OutTransport transport)`	Checks if this binding can use the given transport to send a message

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

decoder

protected org.opensaml.ws.message.decoder.MessageDecoder decoder

encoder

protected org.opensaml.ws.message.encoder.MessageEncoder encoder

uriComparator

public static final org.opensaml.common.binding.decoding.URIComparator uriComparator

URIComparator that strips scheme to avoid issues with reverse proxies

Constructor Detail

SAMLBinding

public SAMLBinding(org.opensaml.ws.message.decoder.MessageDecoder decoder,
                   org.opensaml.ws.message.encoder.MessageEncoder encoder)

Method Detail
- decode
```
public void decode(org.opensaml.ws.message.MessageContext context)
            throws org.opensaml.xml.security.SecurityException,
                   org.opensaml.ws.message.decoder.MessageDecodingException
```
  Decodes the given message.
  
  Parameters:
  
  context - the message to decode
  
  Throws:
  
  org.opensaml.xml.security.SecurityException
  
  org.opensaml.ws.message.decoder.MessageDecodingException
- encode
```
public void encode(org.opensaml.ws.message.MessageContext context)
            throws org.opensaml.ws.message.encoder.MessageEncodingException
```
  Encodes the given message.
  
  Parameters:
  
  context - the message to encode
  
  Throws:
  
  org.opensaml.ws.message.encoder.MessageEncodingException
- getBindingURI
```
public abstract String getBindingURI()
```
  Returns the URI that identifies this binding.
  
  Returns:
  
  the URI
- supports
```
public abstract boolean supports(org.opensaml.ws.transport.InTransport transport)
```
  Checks if this binding can be used to extract the message from the request.
  
  Returns:
  
  true if this binding supports the transport
- supports
```
public abstract boolean supports(org.opensaml.ws.transport.OutTransport transport)
```
  Checks if this binding can use the given transport to send a message
  
  Returns:
  
  true if this binding supports the transport