com.hds.hcpaw.fss.api.model

Class AuthConfig

java.lang.Object

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

com.hds.hcpaw.fss.api.model.AuthConfig

public class AuthConfig
extends BaseFssApiResource

Information about an authentication configuration

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static AuthConfig	create(FssApiVersion apiVersion, java.lang.String name, java.lang.Long priority, java.util.List<AuthConfigFactor> factors) Returns a versioned AuthConfig that is compatible with the specified apiVersion.
java.util.List<AuthConfigFactor>	getAuthConfigFactors() Gets the factors associated with this auth configuration
static java.lang.Class<? extends AuthConfig>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the AuthConfig that corresponds to the specified apiVersion.
java.lang.String	getName() Gets the name of this auth configuration
java.lang.Long	getPriority() Gets the priority of this configuration
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 AuthConfig> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the AuthConfig that corresponds to the specified apiVersion

create

public static AuthConfig create(FssApiVersion apiVersion,
                                java.lang.String name,
                                java.lang.Long priority,
                                java.util.List<AuthConfigFactor> factors)
                         throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported for the AuthConfig

name - Name of this config

priority - Priority of this config

factors - List of factors associated with this config

Returns:

the auth config

Throws:

AwUnsupportedApiVersionException - Unsupported version

getName

public java.lang.String getName()

Gets the name of this auth configuration

Returns:

String

getPriority

public java.lang.Long getPriority()

Gets the priority of this configuration

Returns:

Long

getAuthConfigFactors

public java.util.List<AuthConfigFactor> getAuthConfigFactors()

Gets the factors associated with this auth configuration

Returns:

List

validate

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

Validates this object.

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

See Also:

BaseFssApiResource.validate(String, BaseFssApiResource)