SAMLMessageReceivedEndpointContext (OpenSAML :: SAML Provider API 4.0.0 API)

java.lang.Object
- org.opensaml.messaging.context.BaseContext
- - org.opensaml.saml.common.messaging.context.SAMLMessageReceivedEndpointContext

All Implemented Interfaces:

Iterable<org.opensaml.messaging.context.BaseContext>
```
public class SAMLMessageReceivedEndpointContext
extends org.opensaml.messaging.context.BaseContext
```
A context intended to be used as a subcontext of a MessageContext that carries some basic information about the SAML message.
This context is generally used to hold information about the endpoint at which a SAML message was received. In particular it is useful when the SAML message is being processed during a different HTTP request than the one in which it was actually received.

Nested Class Summary
- Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext
  org.opensaml.messaging.context.BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields
Modifier and Type Field Description

private String requestURL
The request URL.

Constructor Summary

Constructors
Constructor Description

SAMLMessageReceivedEndpointContext()
Constructor.

SAMLMessageReceivedEndpointContext(javax.servlet.http.HttpServletRequest request)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getRequestURL()`	Get the request URL.
`(package private) void`	`setRequestURL(String url)`	Set the request URL.

Methods inherited from class org.opensaml.messaging.context.BaseContext
addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, iterator, removeSubcontext, removeSubcontext, setParent

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - requestURL
```
private String requestURL
```
    The request URL.
- Constructor Detail
  - SAMLMessageReceivedEndpointContext
```
public SAMLMessageReceivedEndpointContext()
```
    Constructor.
  - SAMLMessageReceivedEndpointContext
```
public SAMLMessageReceivedEndpointContext(@Nonnull
                                          javax.servlet.http.HttpServletRequest request)
```
    Constructor.
    This is a convenient copy constructor for info from HttpServletRequest. The constructor does NOT store a reference to the request, it merely copies relevant information to the properties of this class.
    
    Parameters:
    
    request - the HTTP request
- Method Detail
  - getRequestURL
```
@Nullable
public String getRequestURL()
```
    Get the request URL.
    
    Returns:
    
    the request URL
  - setRequestURL
```
void setRequestURL(@Nullable
                   String url)
```
    Set the request URL.
    
    Parameters:
    
    url - the request URL