com.hds.hcpaw.fss.api.model

Class AuthConfigFactor

java.lang.Object

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

com.hds.hcpaw.fss.api.model.AuthConfigFactor

public class AuthConfigFactor
extends BaseFssApiResource

Information about an authentication factor

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static AuthConfigFactor	create(FssApiVersion apiVersion, java.lang.String id, java.lang.String providerId, ProviderType providerType, java.lang.String name, AuthConfigFactorType type, java.lang.Long priority)
static java.lang.Class<? extends AuthConfigFactor>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the AuthConfigFactor that corresponds to the specified apiVersion.
java.lang.String	getId() Gets the factor id
java.lang.String	getName() Gets the factor name
java.lang.Long	getPriority() Gets the factor priority
java.lang.String	getProviderId() Gets the corresponding provider id
ProviderType	getProviderType() Gets the corresponding provider type
AuthConfigFactorType	getType() Gets the factor type
boolean	isActiveDirectory() Returns whether the provider type is AD
boolean	isSAML() Returns whether the provider type is SAML
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 AuthConfigFactor> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the AuthConfigFactor that corresponds to the specified apiVersion

create

public static AuthConfigFactor create(FssApiVersion apiVersion,
                                      java.lang.String id,
                                      java.lang.String providerId,
                                      ProviderType providerType,
                                      java.lang.String name,
                                      AuthConfigFactorType type,
                                      java.lang.Long priority)
                               throws AwUnsupportedApiVersionException

Parameters:

apiVersion -

Returns:

Throws:

AwUnsupportedApiVersionException

getId

public java.lang.String getId()

Gets the factor id

Returns:

String

getProviderId

public java.lang.String getProviderId()

Gets the corresponding provider id

Returns:

String

getProviderType

public ProviderType getProviderType()

Gets the corresponding provider type

Returns:

ProviderType

getName

public java.lang.String getName()

Gets the factor name

Returns:

String

getType

public AuthConfigFactorType getType()

Gets the factor type

Returns:

AuthConfigFactorType

getPriority

public java.lang.Long getPriority()

Gets the factor priority

Returns:

Long

isActiveDirectory

public boolean isActiveDirectory()

Returns whether the provider type is AD

Returns:

boolean

isSAML

public boolean isSAML()

Returns whether the provider type is SAML

Returns:

boolean

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)