WSFederationConstants (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- com.sun.identity.wsfederation.common.WSFederationConstants

```
public final class WSFederationConstants
extends Object
```
WSFederationConstants defines various constants for the WS-Federation implementation

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCOUNT_REALM_COOKIE_NAME` Configuration attribute for account realm cookie name.
`static String`	`ACCOUNT_REALM_COOKIE_NAME_DEFAULT` Default value for account realm cookie name
`static String`	`ACCOUNT_REALM_SELECTION` Configuration attribute for account realm selection mechanism.
`static String`	`ACCOUNT_REALM_SELECTION_DEFAULT` Default mechanism for carrying account realm
`static String`	`ACTIVE_REQUESTOR_PROFILE_ENABLED` Configuration attribute for Active Requestor Profile Enabled setting.
`static String`	`ADDRESS_TAG_NAME` XML tag name for `<Address%gt;`.
`static String`	`AM_WSFEDERATION` Debug log name.
`static String`	`APPLIESTO_TAG_NAME` XML tag name for `<AppliesTo%gt;`.
`static String`	`AUTHENTICATOR_CLASS` Configuration attribute for Authenticator Class setting.
`static String`	`BUNDLE_NAME` Resource bundle name.
`static String`	`CLAIMS_GROUP_DISPLAY_NAME` Display name for Group claim.
`static String`	`CLAIMS_GROUP_URI` Group claim URI.
`static String`	`CLAIMS_URI` Claim URI.
`static String`	`COOKIE` Cookie HTTP header name
`static String`	`DEFAULT_FEDERATION_ID` Entity ID to use if WS-Federation omits it.
`static String`	`DISPLAY_NAME` Configuration attribute for provider display name.
`static String`	`DOMAIN_ATTRIBUTE` Configuration attribute for Domain attribute.
`static String`	`ENDPOINT_BASE_URL` Configuration attribute for Endpoint Base URL setting.
`static String`	`ENTITYID_PARAM` HTTP request parameter for ws-federation entity id
`static String`	`HOME_REALM_DISCOVERY_SERVICE` Configuration attribute for home realm discovery URL.
`static String`	`LOGOUT_DISPLAY_NAME` Attribute name for communicating local provider display name from servlet to JSP
`static String`	`LOGOUT_PROVIDER_LIST` Attribute name for communicating list of providers from servlet to JSP
`static String`	`LOGOUT_WREPLY` Attribute name for communicating WS-Federation wreply parameter from servlet to JSP
`static String`	`METADATA_URL_PREFIX` The URL prefix for WS-Fed metadata requests
`static String`	`METADATA_URL_SUFFIX` The URL suffix for WS-Fed metadata requests
`static String`	`MEX_ENDPOINT_PREFIX` The URL prefix for WS-Fed MEX requests.
`static String`	`NAME_INCLUDES_DOMAIN` Configuration attribute for Trim domain.
`static String`	`NAME_META_ALIAS_IN_URI` Constant used to identify meta alias in URL.
`static int`	`NAMED_CLAIM_COMMONNAME` Index into NAMED_CLAIM_TYPES and NAMED_CLAIM_DISPLAY_NAMES arrays for Common Name
`static String[]`	`NAMED_CLAIM_DISPLAY_NAMES` Claim type Displey names
`static int`	`NAMED_CLAIM_EMAILADDRESS` Index into NAMED_CLAIM_TYPES and NAMED_CLAIM_DISPLAY_NAMES arrays for Email Address
`static String[]`	`NAMED_CLAIM_TYPES` Claim type URIs, as defined in 'WS-Federation: Passive Requestor Interoperability Profile' document
`static int`	`NAMED_CLAIM_UPN` Index into NAMED_CLAIM_TYPES and NAMED_CLAIM_DISPLAY_NAMES arrays for UPN
`static String`	`NAMEID_ATTRIBUTE` Configuration attribute for NameID attribute.
`static String`	`NAMEID_FORMAT` Configuration attribute for NameID format.
`static String`	`NAMEID_INFO` NameID info attribute.
`static String`	`NAMEID_INFO_KEY` NameID info key attribute.
`static String`	`POST_ACTION` Attribute name for communicating form action URL from servlet to JSP
`static String`	`POST_WA` Attribute name for communicating WS-Federation wa parameter from servlet to JSP
`static String`	`POST_WCTX` Attribute name for communicating WS-Federation wctx parameter from servlet to JSP
`static String`	`POST_WRESULT` Attribute name for communicating WS-Federation wresult parameter from servlet to JSP
`static String`	`REALM_PARAM` HTTP request parameter for OpenAM realm
`static String`	`RST_TAG_NAME` XML tag name for `<RequestedSecurityToken%gt;`.
`static String`	`RSTR_TAG_NAME` XML tag name for `<RequestSecurityTokenResponse%gt;`.
`static String`	`SESSION_IDP` Session property name for identity provider from which this service provider has received a token
`static String`	`SESSION_SP_LIST` Session property name for list of service provider to which this identity provider has sent a token
`static String`	`STS_ENDPOINT_PREFIX` The URL prefix for WS-Fed STS requests.
`static String`	`TRUSTED_ADDRESSES` Configuration attribute for Trusted Addresses setting.
`static String`	`UID` The default attribute for short user name
`static String`	`UPN_DOMAIN` Configuration attribute for default UPN domain.
`static String`	`URN_OASIS_NAMES_TC_SAML_11` SAML 1.1 URN.
`static String`	`USERAGENT` User agent HTTP header name
`static String`	`WA` WS-Federation HTTP parameter for 'action'.
`static String`	`WANT_ASSERTION_SIGNED` Configuration attribute - does the service provider require a signature on the assertion?
`static String`	`WCT` WS-Federation HTTP parameter for 'current time'.
`static String`	`WCTX` WS-Federation HTTP parameter for 'context value'.
`static String`	`WHR` WS-Federation HTTP parameter for 'home realm'.
`static String`	`WREPLY` WS-Federation HTTP parameter for 'destination url'.
`static String`	`WREPLY_URL_LIST` List of valid wreply Urls
`static String`	`WRESULT` WS-Federation HTTP parameter for 'result'.
`static String`	`WS_ADDRESSING_URI` WS-Addressing URI.
`static String`	`WS_POLICY_URI` WS-Policy URI.
`static String`	`WSA_NAMESPACE` The XML namespace for WS-Addressing.
`static String`	`WSFEDERATION` WS-Federation data store provider name.
`static String`	`WSIGNIN10` WS-Federation 'sign-in' action.
`static String`	`WSIGNOUT10` WS-Federation 'sign-out' action.
`static String`	`WSIGNOUTCLEANUP10` WS-Federation 'sign-out cleanup' action.
`static String`	`WSSE_NAMESPACE` The XML namespace for WS-Security.
`static String`	`WST_NAMESPACE` The XML namespace for WS-Trust.
`static String`	`WSU_NAMESPACE` The XML namespace for WS-Security Utility.
`static String`	`WTREALM` WS-Federation HTTP parameter for 'requesting realm'.

Constructor Summary

Constructors
Constructor and Description

WSFederationConstants()

Constructors
Constructor and Description
`WSFederationConstants()`

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

- Field Detail
  - WSFEDERATION
```
public static final String WSFEDERATION
```
    WS-Federation data store provider name.
    
    See Also:
    
    Constant Field Values
  - WSIGNIN10
```
public static final String WSIGNIN10
```
    WS-Federation 'sign-in' action.
    
    See Also:
    
    Constant Field Values
  - WSIGNOUT10
```
public static final String WSIGNOUT10
```
    WS-Federation 'sign-out' action.
    
    See Also:
    
    Constant Field Values
  - WSIGNOUTCLEANUP10
```
public static final String WSIGNOUTCLEANUP10
```
    WS-Federation 'sign-out cleanup' action. This is handled identically to WSIGNOUT10, following the WS-Federation 1.1 specification.
    
    See Also:
    
    Constant Field Values
  - RST_TAG_NAME
```
public static final String RST_TAG_NAME
```
    XML tag name for <RequestedSecurityToken%gt;.
    
    See Also:
    
    Constant Field Values
  - RSTR_TAG_NAME
```
public static final String RSTR_TAG_NAME
```
    XML tag name for <RequestSecurityTokenResponse%gt;.
    
    See Also:
    
    Constant Field Values
  - APPLIESTO_TAG_NAME
```
public static final String APPLIESTO_TAG_NAME
```
    XML tag name for <AppliesTo%gt;.
    
    See Also:
    
    Constant Field Values
  - ADDRESS_TAG_NAME
```
public static final String ADDRESS_TAG_NAME
```
    XML tag name for <Address%gt;.
    
    See Also:
    
    Constant Field Values
  - URN_OASIS_NAMES_TC_SAML_11
```
public static final String URN_OASIS_NAMES_TC_SAML_11
```
    SAML 1.1 URN.
    
    See Also:
    
    Constant Field Values
  - CLAIMS_URI
```
public static final String CLAIMS_URI
```
    Claim URI.
    
    See Also:
    
    Constant Field Values
  - CLAIMS_GROUP_URI
```
public static final String CLAIMS_GROUP_URI
```
    Group claim URI.
    
    See Also:
    
    Constant Field Values
  - WS_ADDRESSING_URI
```
public static final String WS_ADDRESSING_URI
```
    WS-Addressing URI.
    
    See Also:
    
    Constant Field Values
  - CLAIMS_GROUP_DISPLAY_NAME
```
public static final String CLAIMS_GROUP_DISPLAY_NAME
```
    Display name for Group claim.
    
    See Also:
    
    Constant Field Values
  - ACCOUNT_REALM_SELECTION
```
public static final String ACCOUNT_REALM_SELECTION
```
    Configuration attribute for account realm selection mechanism.
    
    See Also:
    
    Constant Field Values
  - ACCOUNT_REALM_COOKIE_NAME
```
public static final String ACCOUNT_REALM_COOKIE_NAME
```
    Configuration attribute for account realm cookie name.
    
    See Also:
    
    Constant Field Values
  - HOME_REALM_DISCOVERY_SERVICE
```
public static final String HOME_REALM_DISCOVERY_SERVICE
```
    Configuration attribute for home realm discovery URL.
    
    See Also:
    
    Constant Field Values
  - WANT_ASSERTION_SIGNED
```
public static final String WANT_ASSERTION_SIGNED
```
    Configuration attribute - does the service provider require a signature on the assertion? Default is true.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME
```
public static final String DISPLAY_NAME
```
    Configuration attribute for provider display name.
    
    See Also:
    
    Constant Field Values
  - UPN_DOMAIN
```
public static final String UPN_DOMAIN
```
    Configuration attribute for default UPN domain.
    
    See Also:
    
    Constant Field Values
  - ACCOUNT_REALM_COOKIE_NAME_DEFAULT
```
public static final String ACCOUNT_REALM_COOKIE_NAME_DEFAULT
```
    Default value for account realm cookie name
    
    See Also:
    
    Constant Field Values
  - USERAGENT
```
public static final String USERAGENT
```
    User agent HTTP header name
    
    See Also:
    
    Constant Field Values
  - COOKIE
```
public static final String COOKIE
```
    Cookie HTTP header name
    
    See Also:
    
    Constant Field Values
  - ACCOUNT_REALM_SELECTION_DEFAULT
```
public static final String ACCOUNT_REALM_SELECTION_DEFAULT
```
    Default mechanism for carrying account realm
    
    See Also:
    
    Constant Field Values
  - NAMEID_INFO
```
public static final String NAMEID_INFO
```
    NameID info attribute.
    
    See Also:
    
    Constant Field Values
  - NAMEID_INFO_KEY
```
public static final String NAMEID_INFO_KEY
```
    NameID info key attribute.
    
    See Also:
    
    Constant Field Values
  - SESSION_SP_LIST
```
public static final String SESSION_SP_LIST
```
    Session property name for list of service provider to which this identity provider has sent a token
    
    See Also:
    
    Constant Field Values
  - SESSION_IDP
```
public static final String SESSION_IDP
```
    Session property name for identity provider from which this service provider has received a token
    
    See Also:
    
    Constant Field Values
  - POST_ACTION
```
public static final String POST_ACTION
```
    Attribute name for communicating form action URL from servlet to JSP
    
    See Also:
    
    Constant Field Values
  - POST_WA
```
public static final String POST_WA
```
    Attribute name for communicating WS-Federation wa parameter from servlet to JSP
    
    See Also:
    
    Constant Field Values
  - POST_WCTX
```
public static final String POST_WCTX
```
    Attribute name for communicating WS-Federation wctx parameter from servlet to JSP
    
    See Also:
    
    Constant Field Values
  - POST_WRESULT
```
public static final String POST_WRESULT
```
    Attribute name for communicating WS-Federation wresult parameter from servlet to JSP
    
    See Also:
    
    Constant Field Values
  - LOGOUT_DISPLAY_NAME
```
public static final String LOGOUT_DISPLAY_NAME
```
    Attribute name for communicating local provider display name from servlet to JSP
    
    See Also:
    
    Constant Field Values
  - LOGOUT_WREPLY
```
public static final String LOGOUT_WREPLY
```
    Attribute name for communicating WS-Federation wreply parameter from servlet to JSP
    
    See Also:
    
    Constant Field Values
  - LOGOUT_PROVIDER_LIST
```
public static final String LOGOUT_PROVIDER_LIST
```
    Attribute name for communicating list of providers from servlet to JSP
    
    See Also:
    
    Constant Field Values
  - AM_WSFEDERATION
```
public static String AM_WSFEDERATION
```
    Debug log name.
  - BUNDLE_NAME
```
public static final String BUNDLE_NAME
```
    Resource bundle name.
    
    See Also:
    
    Constant Field Values
  - NAME_META_ALIAS_IN_URI
```
public static final String NAME_META_ALIAS_IN_URI
```
    Constant used to identify meta alias in URL.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FEDERATION_ID
```
public static final String DEFAULT_FEDERATION_ID
```
    Entity ID to use if WS-Federation omits it.
    
    See Also:
    
    Constant Field Values
  - WA
```
public static final String WA
```
    WS-Federation HTTP parameter for 'action'.
    
    See Also:
    
    Constant Field Values
  - WRESULT
```
public static final String WRESULT
```
    WS-Federation HTTP parameter for 'result'.
    
    See Also:
    
    Constant Field Values
  - WHR
```
public static final String WHR
```
    WS-Federation HTTP parameter for 'home realm'.
    
    See Also:
    
    Constant Field Values
  - WTREALM
```
public static final String WTREALM
```
    WS-Federation HTTP parameter for 'requesting realm'.
    
    See Also:
    
    Constant Field Values
  - WREPLY
```
public static final String WREPLY
```
    WS-Federation HTTP parameter for 'destination url'.
    
    See Also:
    
    Constant Field Values
  - WCT
```
public static final String WCT
```
    WS-Federation HTTP parameter for 'current time'.
    
    See Also:
    
    Constant Field Values
  - WCTX
```
public static final String WCTX
```
    WS-Federation HTTP parameter for 'context value'.
    
    See Also:
    
    Constant Field Values
  - REALM_PARAM
```
public static final String REALM_PARAM
```
    HTTP request parameter for OpenAM realm
    
    See Also:
    
    Constant Field Values
  - ENTITYID_PARAM
```
public static final String ENTITYID_PARAM
```
    HTTP request parameter for ws-federation entity id
    
    See Also:
    
    Constant Field Values
  - NAMED_CLAIM_TYPES
```
public static final String[] NAMED_CLAIM_TYPES
```
    Claim type URIs, as defined in 'WS-Federation: Passive Requestor Interoperability Profile' document
  - NAMED_CLAIM_DISPLAY_NAMES
```
public static final String[] NAMED_CLAIM_DISPLAY_NAMES
```
    Claim type Displey names
  - NAMED_CLAIM_UPN
```
public static final int NAMED_CLAIM_UPN
```
    Index into NAMED_CLAIM_TYPES and NAMED_CLAIM_DISPLAY_NAMES arrays for UPN
    
    See Also:
    
    Constant Field Values
  - NAMED_CLAIM_EMAILADDRESS
```
public static final int NAMED_CLAIM_EMAILADDRESS
```
    Index into NAMED_CLAIM_TYPES and NAMED_CLAIM_DISPLAY_NAMES arrays for Email Address
    
    See Also:
    
    Constant Field Values
  - NAMED_CLAIM_COMMONNAME
```
public static final int NAMED_CLAIM_COMMONNAME
```
    Index into NAMED_CLAIM_TYPES and NAMED_CLAIM_DISPLAY_NAMES arrays for Common Name
    
    See Also:
    
    Constant Field Values
  - NAMEID_ATTRIBUTE
```
public static final String NAMEID_ATTRIBUTE
```
    Configuration attribute for NameID attribute.
    
    See Also:
    
    Constant Field Values
  - NAMEID_FORMAT
```
public static final String NAMEID_FORMAT
```
    Configuration attribute for NameID format.
    
    See Also:
    
    Constant Field Values
  - NAME_INCLUDES_DOMAIN
```
public static final String NAME_INCLUDES_DOMAIN
```
    Configuration attribute for Trim domain.
    
    See Also:
    
    Constant Field Values
  - DOMAIN_ATTRIBUTE
```
public static final String DOMAIN_ATTRIBUTE
```
    Configuration attribute for Domain attribute.
    
    See Also:
    
    Constant Field Values
  - UID
```
public static final String UID
```
    The default attribute for short user name
    
    See Also:
    
    Constant Field Values
  - METADATA_URL_PREFIX
```
public static final String METADATA_URL_PREFIX
```
    The URL prefix for WS-Fed metadata requests
    
    See Also:
    
    Constant Field Values
  - METADATA_URL_SUFFIX
```
public static final String METADATA_URL_SUFFIX
```
    The URL suffix for WS-Fed metadata requests
    
    See Also:
    
    Constant Field Values
  - MEX_ENDPOINT_PREFIX
```
public static final String MEX_ENDPOINT_PREFIX
```
    The URL prefix for WS-Fed MEX requests.
    
    See Also:
    
    Constant Field Values
  - STS_ENDPOINT_PREFIX
```
public static final String STS_ENDPOINT_PREFIX
```
    The URL prefix for WS-Fed STS requests.
    
    See Also:
    
    Constant Field Values
  - WS_POLICY_URI
```
public static final String WS_POLICY_URI
```
    WS-Policy URI.
    
    See Also:
    
    Constant Field Values
  - WREPLY_URL_LIST
```
public static String WREPLY_URL_LIST
```
    List of valid wreply Urls
  - WSA_NAMESPACE
```
public static final String WSA_NAMESPACE
```
    The XML namespace for WS-Addressing.
    
    See Also:
    
    Constant Field Values
  - WSSE_NAMESPACE
```
public static final String WSSE_NAMESPACE
```
    The XML namespace for WS-Security.
    
    See Also:
    
    Constant Field Values
  - WST_NAMESPACE
```
public static final String WST_NAMESPACE
```
    The XML namespace for WS-Trust.
    
    See Also:
    
    Constant Field Values
  - WSU_NAMESPACE
```
public static final String WSU_NAMESPACE
```
    The XML namespace for WS-Security Utility.
    
    See Also:
    
    Constant Field Values
  - ACTIVE_REQUESTOR_PROFILE_ENABLED
```
public static String ACTIVE_REQUESTOR_PROFILE_ENABLED
```
    Configuration attribute for Active Requestor Profile Enabled setting.
  - ENDPOINT_BASE_URL
```
public static String ENDPOINT_BASE_URL
```
    Configuration attribute for Endpoint Base URL setting.
  - TRUSTED_ADDRESSES
```
public static String TRUSTED_ADDRESSES
```
    Configuration attribute for Trusted Addresses setting.
  - AUTHENTICATOR_CLASS
```
public static String AUTHENTICATOR_CLASS
```
    Configuration attribute for Authenticator Class setting.
- Constructor Detail
  - WSFederationConstants
```
public WSFederationConstants()
```

Class WSFederationConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WSFEDERATION

WSIGNIN10

WSIGNOUT10

WSIGNOUTCLEANUP10

RST_TAG_NAME

RSTR_TAG_NAME

APPLIESTO_TAG_NAME

ADDRESS_TAG_NAME

URN_OASIS_NAMES_TC_SAML_11

CLAIMS_URI

CLAIMS_GROUP_URI

WS_ADDRESSING_URI

CLAIMS_GROUP_DISPLAY_NAME

ACCOUNT_REALM_SELECTION

ACCOUNT_REALM_COOKIE_NAME

HOME_REALM_DISCOVERY_SERVICE

WANT_ASSERTION_SIGNED

DISPLAY_NAME

UPN_DOMAIN

ACCOUNT_REALM_COOKIE_NAME_DEFAULT

USERAGENT

COOKIE

ACCOUNT_REALM_SELECTION_DEFAULT

NAMEID_INFO

NAMEID_INFO_KEY

SESSION_SP_LIST

SESSION_IDP

POST_ACTION

POST_WA

POST_WCTX

POST_WRESULT

LOGOUT_DISPLAY_NAME

LOGOUT_WREPLY

LOGOUT_PROVIDER_LIST

AM_WSFEDERATION

BUNDLE_NAME

NAME_META_ALIAS_IN_URI

DEFAULT_FEDERATION_ID

WA

WRESULT

WHR

WTREALM

WREPLY

WCT

WCTX

REALM_PARAM

ENTITYID_PARAM

NAMED_CLAIM_TYPES

NAMED_CLAIM_DISPLAY_NAMES

NAMED_CLAIM_UPN

NAMED_CLAIM_EMAILADDRESS

NAMED_CLAIM_COMMONNAME

NAMEID_ATTRIBUTE

NAMEID_FORMAT

NAME_INCLUDES_DOMAIN

DOMAIN_ATTRIBUTE

UID

METADATA_URL_PREFIX

METADATA_URL_SUFFIX

MEX_ENDPOINT_PREFIX

STS_ENDPOINT_PREFIX

WS_POLICY_URI

WREPLY_URL_LIST

WSA_NAMESPACE

WSSE_NAMESPACE

WST_NAMESPACE

WSU_NAMESPACE

ACTIVE_REQUESTOR_PROFILE_ENABLED

ENDPOINT_BASE_URL

TRUSTED_ADDRESSES

AUTHENTICATOR_CLASS

Constructor Detail

WSFederationConstants