Package com.day.cq.dam.scene7.api

Interface Scene7EndpointsManager

public interface Scene7EndpointsManager

The Scene7EndpointsManager is responsible for monitoring and providing endpoints' details to services that need this information.

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_URL_PROP
static String	API_VERSION_PROP
static String	DEFAULT_SECURE_PREVIEW_URL_PROP
static String	ENDPOINT_RESOURCE_TYPE
static String	ENDPOINTS_ROOT_FOLDER
static String	IPS_URL_PROP
static String	SPS_URL_PROP
static String	VIEWERSDK_URL_PROP

Method Summary

Modifier and Type	Method	Description
URL	getAPIServer(String region)	Returns the URL for the API server corresponding to a region.
String	getAPIVersion(String region)	Returns the API version of servers from a region.
URL	getIPSServer(String region)	Returns the URL for the IPS server corresponding to a region.
List<Scene7Endpoint>	getScene7Endpoints()	Returns a list of the registered Scene7 endpoints.
URL	getSPSServer(String region)	Returns the URL for the SPS server corresponding to a region.
URL	getViewerSdkServer(String region)	Returns the URL for the viewer SDK corresponding to a region.

Field Detail

ENDPOINTS_ROOT_FOLDER

static final String ENDPOINTS_ROOT_FOLDER

See Also:

Constant Field Values

ENDPOINT_RESOURCE_TYPE

static final String ENDPOINT_RESOURCE_TYPE

See Also:

Constant Field Values

API_URL_PROP

static final String API_URL_PROP

See Also:

Constant Field Values

IPS_URL_PROP

static final String IPS_URL_PROP

See Also:

Constant Field Values

SPS_URL_PROP

static final String SPS_URL_PROP

See Also:

Constant Field Values

DEFAULT_SECURE_PREVIEW_URL_PROP

static final String DEFAULT_SECURE_PREVIEW_URL_PROP

See Also:

Constant Field Values

VIEWERSDK_URL_PROP

static final String VIEWERSDK_URL_PROP

See Also:

Constant Field Values

API_VERSION_PROP

static final String API_VERSION_PROP

See Also:

Constant Field Values

Method Detail

getAPIServer

URL getAPIServer(String region)

Returns the URL for the API server corresponding to a region.

Parameters:

region -

Returns:

an URL object representing the API server URL

getIPSServer

URL getIPSServer(String region)

Returns the URL for the IPS server corresponding to a region.

Parameters:

region -

Returns:

an URL object representing the IPS server URL

getSPSServer

URL getSPSServer(String region)

Returns the URL for the SPS server corresponding to a region.

Parameters:

region -

Returns:

an URL object representing the SPS server URL

getViewerSdkServer

URL getViewerSdkServer(String region)

Returns the URL for the viewer SDK corresponding to a region.

Parameters:

region -

Returns:

an URL object representing the viewer SDK URL

getAPIVersion

String getAPIVersion(String region)

Returns the API version of servers from a region.

Parameters:

region -

Returns:

API version

getScene7Endpoints

List<Scene7Endpoint> getScene7Endpoints()

Returns a list of the registered Scene7 endpoints.

Returns:

the endpoints