Package org.forgerock.openig.ping

Class PingOneService

java.lang.Object

org.forgerock.openig.ping.PingOneService

public class PingOneService
extends Object

The PingOneService supports integration with PingOne environments, providing the service URI (or base URI in the case of REST actions), and a handler to be used with these endpoints. The endpointHandler should be configured so as to correctly obtain required PingOne authorization (e.g. an access_token).

 {
      "type": "PingOneService",
      "config": {
         "serviceEndpoint"      : Config Expression<URI>      [REQUIRED - The environment's service endpoint URI.]
         "endpointHandler"      : Handler                     [OPTIONAL - The Handler to use to make requests on the
                                                                          service endpoints - defaults to the
                                                                          heap-defined ForgeRockClientHandler.]
      }
 }
 
 

The example configuration below illustrates PingOne Protect service config:

 {
     "name" : "pingOneProtectService",
     "type" : "PingOneService",
     "config" : {
       "serviceEndpoint" : "https://&{api}/v1/environments/&{env}",
       "endpointHandler" : "evaluationEndpointHandler"
     }
 }
 
 

Notes:

• The serviceEndpoint is the root service endpoint for the given environment, from which other endpoint URIs may be derived - e.g. the PingOne Protect risk evaluation endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PingOneService.Heaplet	Creates and initialises a PingOneService in a heap environment.

Method Summary

Modifier and Type	Method	Description
Handler	getEndpointHandler()	Get the Handler providing access to the service endpoint.
URI	getRiskEvaluationEndpoint()	Get the PingOne Protect risk evaluation endpoint URI.
URI	getServiceEndpoint()	Get the service endpoint URI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getServiceEndpoint

public URI getServiceEndpoint()

Get the service endpoint URI.

Returns:

the service endpoint URI

getRiskEvaluationEndpoint

public URI getRiskEvaluationEndpoint()

Get the PingOne Protect risk evaluation endpoint URI.

Returns:

the risk evaluation endpoint URI

getEndpointHandler

public Handler getEndpointHandler()

Get the Handler providing access to the service endpoint.

Returns:

the service endpoint Handler