org.apache.geode.management.api

Interface RestfulEndpoint

All Superinterfaces:

org.apache.geode.lang.Identifiable<java.lang.String>, java.io.Serializable

All Known Implementing Classes:

GatewayReceiverConfig, MemberConfig, Pdx, RegionConfig, RegionConfig.Index

@Experimental
public interface RestfulEndpoint
extends org.apache.geode.lang.Identifiable<java.lang.String>

a restful service request just needs: 1. an endpoint to list all instances (e.g. "/regions") 2. an id mechanism to distinguish instance (e.g. "{id}") 3. an endpoint to update or delete an individual instance (e.g. "/regions/{id}")

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	URI_CONTEXT
static java.lang.String	URI_VERSION

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEndpoint() this returns the URI that display the list of entries.
default java.lang.String	getIdentityEndPoint() return the uri that points to a single entity.
default java.lang.String	getUri() return the full uri path that points to a single entity.

Methods inherited from interface org.apache.geode.lang.Identifiable

getId

Field Detail

URI_CONTEXT

static final java.lang.String URI_CONTEXT

See Also:

Constant Field Values

URI_VERSION

static final java.lang.String URI_VERSION

See Also:

Constant Field Values

Method Detail

getEndpoint

java.lang.String getEndpoint()

this returns the URI that display the list of entries. it should return URI the part after /experimental

Returns:

e.g. /regions

getIdentityEndPoint

default java.lang.String getIdentityEndPoint()

return the uri that points to a single entity. If the id is not available for the object, this will return null it should return the URI part after /experimental

Returns:

e.g. /regions/regionA

getUri

default java.lang.String getUri()

return the full uri path that points to a single entity. If the id is not available for the object, this will return null it should return the URI part after http://hostname:port

Returns:

e.g. /management/experimental/regions/regionA