Package com.pushtechnology.diffusion.api.config

Interface RestServiceConfig

All Superinterfaces:

Config

public interface RestServiceConfig
extends Config

REST service configuration.

This is an optional configuration for a Web Server. If this configuration is configured, corresponding REST APIs will be exposed for users.

No values can be changed after the server has been started.

Since:

6.10

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RestServiceConfig.RestApiConfig	REST API specific configuration.
static enum	RestServiceConfig.RestApiType	Supported REST API types.

Method Summary

Modifier and Type	Method	Description
RestServiceConfig.RestApiConfig	addRestApiConfig(RestServiceConfig.RestApiType restApiType)	Creates and adds RestServiceConfig.RestApiConfig of RestServiceConfig.RestApiType.
RestServiceConfig.RestApiConfig	getRestApiConfig(RestServiceConfig.RestApiType restApiType)	Returns RestServiceConfig.RestApiConfig associated with supplied RestServiceConfig.RestApiType.
long	getSessionTokenTimeoutInMins()	Gets the timeout value, in minutes, for the REST session token, after it is last accessed.
void	removeRestApiConfig(RestServiceConfig.RestApiType restApiType)	Removes RestServiceConfig.RestApiConfig of supplied type.
void	setSessionTokenTimeoutInMins(long sessionTokenTimeoutInMins)	Sets the session token time out value in minutes.

Methods inherited from interface com.pushtechnology.diffusion.api.config.Config

isLocked

Method Details

getSessionTokenTimeoutInMins

long getSessionTokenTimeoutInMins()

Gets the timeout value, in minutes, for the REST session token, after it is last accessed.

Session token is generated to be used to access REST APIs. If the session token is used after it times out, it will be invalidated and removed from the server.

If this is not specified, a default of 5 minutes is used.

Returns:

the timeout value, in minutes, for the session token after it is last accessed

setSessionTokenTimeoutInMins

void setSessionTokenTimeoutInMins(long sessionTokenTimeoutInMins)
                           throws ConfigException

Sets the session token time out value in minutes.

Parameters:

sessionTokenTimeoutInMins - timeout value for session token, in minutes

Throws:

ConfigException - if setting session token time out fails

getRestApiConfig

RestServiceConfig.RestApiConfig getRestApiConfig(RestServiceConfig.RestApiType restApiType)

Returns RestServiceConfig.RestApiConfig associated with supplied RestServiceConfig.RestApiType.

Parameters:

restApiType - RestServiceConfig.RestApiType to use to get RestServiceConfig.RestApiConfig

Returns:

associated RestServiceConfig.RestApiConfig with supplied RestServiceConfig.RestApiType

addRestApiConfig

RestServiceConfig.RestApiConfig addRestApiConfig(RestServiceConfig.RestApiType restApiType)
                                          throws ConfigException

Creates and adds RestServiceConfig.RestApiConfig of RestServiceConfig.RestApiType.

Parameters:

restApiType - type of REST api config to add.

Returns:

added instance of RestServiceConfig.RestApiConfig

Throws:

ConfigException - if RestServiceConfig.RestApiConfig of supplied type already exists or creating the instance fails

removeRestApiConfig

void removeRestApiConfig(RestServiceConfig.RestApiType restApiType)
                  throws ConfigException

Removes RestServiceConfig.RestApiConfig of supplied type.

Parameters:

restApiType - type of REST API configuration to remove

Throws:

ConfigException - if removal of RestServiceConfig.RestApiConfig fails