com.pingidentity.pa.sdk.accessor.tps

Class ThirdPartyServiceModel

java.lang.Object

com.pingidentity.pa.sdk.accessor.tps.ThirdPartyServiceModel

public final class ThirdPartyServiceModel
extends Object

Represents a third-party service configured in the Administrative API To obtain access to the configuration contained in a ThirdPartyServiceModel, a plugin should define a field in its PluginConfiguration with a type of ThirdPartyServiceModel and configure the associated ConfigurationField to use a ConfigurationModelAccessor of ThirdPartyServiceAccessor. A ThirdPartyServiceModel is guaranteed to be uniquely identified by the id returned from getId()). This field is also the only field utilized for hashCode() and equals(Object).

Constructor Summary

Constructors

Constructor and Description
ThirdPartyServiceModel(String id, String name) Construct a ThirdPartyServiceModel.
ThirdPartyServiceModel(String id, String name, String requestUri) Construct a ThirdPartyServiceModel.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getId()
String	getName()
Optional<String>	getRequestUri()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ThirdPartyServiceModel

public ThirdPartyServiceModel(String id,
                              String name)

Construct a ThirdPartyServiceModel.

Parameters:

id - the id of the associated third-party service

name - the name of the associated third-party service

ThirdPartyServiceModel

public ThirdPartyServiceModel(String id,
                              String name,
                              String requestUri)

Construct a ThirdPartyServiceModel.

Parameters:

id - the id of the associated third-party service

name - the name of the associated third-party service

requestUri - the relative path uri to be used for requests to a third-party service

Method Detail

getId

public String getId()

Returns:

the id of the third-party service

getName

public String getName()

Returns:

the name of the third-party service

getRequestUri

public Optional<String> getRequestUri()

Returns:

the relative path to use for requests to a third-party service. An empty Optional if a third-party service can be accessed through an arbitrary path.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object