com.hds.hcpaw.fss.api.model

Class AuthConfigListing

java.lang.Object

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

com.hds.hcpaw.fss.api.model.AuthConfigListing

public class AuthConfigListing
extends BaseFssApiResource

Represents a list of authentication configurations configured on the system.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static AuthConfigListing	create(FssApiVersion apiVersion, java.util.List<AuthConfig> configs) Returns a versioned AuthConfigListing that is compatible with the specified apiVersion.
java.util.List<AuthConfig>	getAuthConfigs() Returns a list of AuthConfigs.
static java.lang.Class<? extends AuthConfigListing>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the AuthConfigListing that corresponds to the specified apiVersion.
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 AuthConfigListing> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the AuthConfigListing that corresponds to the specified apiVersion

create

public static AuthConfigListing create(FssApiVersion apiVersion,
                                       java.util.List<AuthConfig> configs)
                                throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the AuthConfigListing

configs - a list of configs

Returns:

the constructed AuthConfigListing

Throws:

AwUnsupportedApiVersionException - Unuspported api version

validate

public 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)

getAuthConfigs

public java.util.List<AuthConfig> getAuthConfigs()

Returns a list of AuthConfigs.

Returns:

a list of AuthConfigs.