com.hds.hcpaw.fss.api.model

Class SamlRedirectRequest

java.lang.Object

com.hds.hcpaw.fss.api.model.BaseFssApiResource

com.hds.hcpaw.fss.api.model.SamlRedirectRequest

public abstract class SamlRedirectRequest
extends BaseFssApiResource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SamlRedirectRequest.FssClientType

Field Summary

Fields inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

UTF_8

Method Summary

Modifier and Type	Method and Description
static SamlRedirectRequest	create(FssApiVersion apiVersion, java.lang.String id, java.lang.String location, SamlRedirectRequest.FssClientType clientType) Returns a versioned SamlRedirectRequest that is compatible with the specified apiVersion.
SamlRedirectRequest.FssClientType	getClientType() Returns the client type
static java.lang.Class<? extends SamlRedirectRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the SamlRedirectRequest that corresponds to the specified apiVersion.
java.lang.String	getId() Returns the ID of the IDP.
java.lang.String	getLocation() Returns the location
protected void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

Methods inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

badValue, badValue, fromJson, toJson, toJson, toString, validate, validateFieldInRange, validateFieldInRange, validateFieldIsNull, validateFieldNotNull, validateLocale, validateOptionalField, validateOptionalFieldList, validateRequiredField, validateRequiredFieldList, writeToOutputStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getFssApiClass

public static java.lang.Class<? extends SamlRedirectRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                     throws AwUnsupportedApiVersionException

Returns the Class of the SamlRedirectRequest that corresponds to the specified apiVersion.

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the SamlRedirectRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static SamlRedirectRequest create(FssApiVersion apiVersion,
                                         java.lang.String id,
                                         java.lang.String location,
                                         SamlRedirectRequest.FssClientType clientType)
                                  throws AwUnsupportedApiVersionException

Returns a versioned SamlRedirectRequest that is compatible with the specified apiVersion.

Parameters:

apiVersion - API version to be supported by the SamlRedirectRequest

id - Resource ID of the IDP

location - URL to return to after SAML authentication completes

clientType - PORTAL (default) or CLIENT

Returns:

The constructed SamlRedirectRequest.

Throws:

AwUnsupportedApiVersionException

getId

public java.lang.String getId()

Returns the ID of the IDP.

Returns:

the ID of the IDP

getLocation

public java.lang.String getLocation()

Returns the location

Returns:

the location

getClientType

public SamlRedirectRequest.FssClientType getClientType()

Returns the client type

Returns:

the client type

validate

protected void validate(java.lang.String fieldName,
                        BaseFssApiResource parent)
                 throws AwJsonException

Description copied from class: BaseFssApiResource

Validates this object. Implementers of this method should call the various validate methods in this class for the fields in the class. For example, if an implementing class has a required field called foo and an optional field called bar, then this method should call BaseFssApiResource.validateRequiredField(String, BaseFssApiResource, String) for foo, and BaseFssApiResource.validateOptionalField(String, BaseFssApiResource) for bar.

Specified by:

validate in class BaseFssApiResource

Parameters:

fieldName - name of this object in the parent (containing) object. If this object is a top-level object (not contained within another object), then enter null for this parameter

parent - parent (containing) object that contains the object specified in the fieldName parameter. If this object is a top-level object (not contained within another object), then enter null for this parameter

Throws:

AwJsonException - if any validation errors occur