Package org.forgerock.openig.http

Class ServerInfoSingletonProvider

java.lang.Object

org.forgerock.openig.http.ServerInfoSingletonProvider

All Implemented Interfaces:

SingletonResourceProvider

public class ServerInfoSingletonProvider
extends Object
implements SingletonResourceProvider

Provides server info (build-time defined values only at the moment) in a read-only fashion.

Constructor Summary

Constructors

Constructor	Description
ServerInfoSingletonProvider(ProductInfo productInfo)	Create a new ServerInfoSingletonProvider.

Method Summary

Modifier and Type	Method	Description
Promise<ActionResponse,ResourceException>	actionInstance(Context context, ActionRequest request)	Performs the provided action against the single resource instance.
Promise<ResourceResponse,ResourceException>	patchInstance(Context context, PatchRequest request)	Patches the single resource instance.
Promise<ResourceResponse,ResourceException>	readInstance(Context context, ReadRequest request)	Reads the single resource instance.
Promise<ResourceResponse,ResourceException>	updateInstance(Context context, UpdateRequest request)	Updates the single resource instance.

Methods inherited from class java.lang.Object

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

Constructor Details

ServerInfoSingletonProvider

public ServerInfoSingletonProvider(ProductInfo productInfo)

Create a new ServerInfoSingletonProvider.

Parameters:

productInfo - the product information.

Method Details

readInstance

public Promise<ResourceResponse,ResourceException> readInstance(Context context,
 ReadRequest request)

Description copied from interface: SingletonResourceProvider

Reads the single resource instance.

Specified by:

readInstance in interface SingletonResourceProvider

Parameters:

context - The request server context.

request - The read request.

Returns:

A Promise containing the result of the operation.

See Also:

• RequestHandler.handleRead(Context, ReadRequest)

actionInstance

public Promise<ActionResponse,ResourceException> actionInstance(Context context,
 ActionRequest request)

Description copied from interface: SingletonResourceProvider

Performs the provided action against the single resource instance.

Specified by:

actionInstance in interface SingletonResourceProvider

Parameters:

context - The request server context.

request - The action request.

Returns:

A Promise containing the result of the operation.

See Also:

• RequestHandler.handleAction(Context, ActionRequest)

patchInstance

public Promise<ResourceResponse,ResourceException> patchInstance(Context context,
 PatchRequest request)

Description copied from interface: SingletonResourceProvider

Patches the single resource instance.

Specified by:

patchInstance in interface SingletonResourceProvider

Parameters:

context - The request server context.

request - The patch request.

Returns:

A Promise containing the result of the operation.

See Also:

• RequestHandler.handlePatch(Context, PatchRequest)

updateInstance

public Promise<ResourceResponse,ResourceException> updateInstance(Context context,
 UpdateRequest request)

Description copied from interface: SingletonResourceProvider

Updates the single resource instance.

Specified by:

updateInstance in interface SingletonResourceProvider

Parameters:

context - The request server context.

request - The update request.

Returns:

A Promise containing the result of the operation.

See Also:

• RequestHandler.handleUpdate(Context, UpdateRequest)