com.hds.hcpaw.fss.api.model

Class Provider

java.lang.Object

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

com.hds.hcpaw.fss.api.model.Provider

public class Provider
extends BaseFssApiResource

Information about the authentication provider

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static Provider	create(FssApiVersion apiVersion, java.lang.String id, java.lang.String name, ProviderType type) Returns a versioned Provider that is compatible with the specified apiVersion.
static java.lang.Class<? extends Provider>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the Provider that corresponds to the specified apiVersion.
java.lang.String	getId() Returns the id of the provider
java.lang.String	getName() Returns the name of the provider
ProviderType	getType() Returns the type of the provider
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 Provider> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the Provider that corresponds to the specified apiVersion

create

public static Provider create(FssApiVersion apiVersion,
                              java.lang.String id,
                              java.lang.String name,
                              ProviderType type)
                       throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported for the Provider

id - Id of the provider

name - Name of the provider

type - Type of the provider

Returns:

the provider

Throws:

AwUnsupportedApiVersionException

getId

public java.lang.String getId()

Returns the id of the provider

Returns:

getName

public java.lang.String getName()

Returns the name of the provider

Returns:

getType

public ProviderType getType()

Returns the type of the provider

Returns:

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)