net.shibboleth.idp.saml.profile.impl

Class IdPInitiatedSSORequest

java.lang.Object

net.shibboleth.idp.saml.profile.impl.IdPInitiatedSSORequest

@ThreadSafe
public class IdPInitiatedSSORequest
extends Object

Object representing a Shibboleth Authentication Request message. This message is used for IdP-initiated authentication requests and is defined by the Shibboleth Architecture Protocol and Profiles specification. Note, this document was written prior to the creation of SAML 2 and so only mentioned version 1 but this message may be used with either version. The SAML 2 authentication request should be used by SAML 2 service providers wishing to initiate authentication.

Field Summary

Fields

Modifier and Type	Field and Description
private String	acsURL The assertion consumer service endpoint, at the service provider, to which to deliver the authentication response.
private String	entityId The entityID of the requesting service provider.
private String	relayState An opaque value to be returned to the service provider with the authentication response.
private long	time The current time, at the service provider, in milliseconds since the epoch.

Constructor Summary

Constructors

Constructor and Description
IdPInitiatedSSORequest(String newEntityId, String url, String target, Long newTime) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAssertionConsumerServiceURL() Get the assertion consumer service endpoint at the SP to which to deliver the response.
String	getEntityId() Get the entityID of the requesting relying party.
String	getRelayState() Get the opaque value to be returned to the SP with the response.
long	getTime() Get the current time at the SP, in milliseconds since the epoch.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

entityId

@Nonnull
@NotEmpty
private final String entityId

The entityID of the requesting service provider.

acsURL

@Nullable
private final String acsURL

The assertion consumer service endpoint, at the service provider, to which to deliver the authentication response.

relayState

@Nullable
private final String relayState

An opaque value to be returned to the service provider with the authentication response.

time

@Positive
private final long time

The current time, at the service provider, in milliseconds since the epoch.

Constructor Detail

IdPInitiatedSSORequest

public IdPInitiatedSSORequest(@Nonnull@NotEmpty
                      String newEntityId,
                      @Nullable
                      String url,
                      @Nullable
                      String target,
                      @Nullable@Positive
                      Long newTime)

Constructor.

If no message time is supplied, then the current time at the IdP is used.

Parameters:

newEntityId - entity ID of the requesting SP

url - assertion consumer service endpoint at the SP to which to deliver the response

target - opaque value to be returned to the SP with the response

newTime - current time at the SP, in milliseconds since the epoch, must be greater than zero

Method Detail

getEntityId

@Nonnull
@NotEmpty
public String getEntityId()

Get the entityID of the requesting relying party.

Returns:

entityID of the requesting relying party

getAssertionConsumerServiceURL

@Nullable
public String getAssertionConsumerServiceURL()

Get the assertion consumer service endpoint at the SP to which to deliver the response.

Returns:

assertion consumer service endpoint at the SP to which to deliver the response

getRelayState

@Nullable
public String getRelayState()

Get the opaque value to be returned to the SP with the response.

Returns:

opaque value to be returned to the SP with the response

getTime

public long getTime()

Get the current time at the SP, in milliseconds since the epoch.

Returns:

current time at the SP, in milliseconds since the epoch

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object