Package org.forgerock.openam.services.push

Class PushNotificationServiceConfig

java.lang.Object

org.forgerock.openam.services.push.PushNotificationServiceConfig

public final class PushNotificationServiceConfig
extends Object

Config class for a Push Notification Service.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PushNotificationServiceConfig.Builder	Internal builder for the config to ease creation.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object underTest)
String	getAccessKey()	Get the api key to allow access to the remote service.
String	getAppleEndpoint()	Get the endpoint for this notification service to connect to.
String	getDelegateFactory()	Get the delegate factory class used to produce delegates.
String	getGoogleEndpoint()	Get the endpoint for this notification service to connect to.
int	getMessageDispatcherConcurrency()	Gets the level of concurrency to use when accessing the message dispatcher cache.
long	getMessageDispatcherDuration()	Get the duration the message dispatcher should hold messages for.
long	getMessageDispatcherSize()	Get the message dispatcher size from this config.
String	getRegion()	Get the region in which this client exists.
String	getSecret()	Get the sender ID to authenticate to the remote service.
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Detail

getAccessKey

public String getAccessKey()

Get the api key to allow access to the remote service.

Returns:

the api key.

getSecret

public String getSecret()

Get the sender ID to authenticate to the remote service.

Returns:

the sender id.

getAppleEndpoint

public String getAppleEndpoint()

Get the endpoint for this notification service to connect to.

Returns:

the endpoint.

getGoogleEndpoint

public String getGoogleEndpoint()

Get the endpoint for this notification service to connect to.

Returns:

the endpoint.

getDelegateFactory

public String getDelegateFactory()

Get the delegate factory class used to produce delegates.

Returns:

the delegate factory.

getRegion

public String getRegion()

Get the region in which this client exists.

Returns:

the region for this client.

getMessageDispatcherSize

public long getMessageDispatcherSize()

Get the message dispatcher size from this config.

Returns:

The number of entries the message dispatcher should hold.

getMessageDispatcherDuration

public long getMessageDispatcherDuration()

Get the duration the message dispatcher should hold messages for.

Returns:

The time (in seconds) message inboxes should be open for.

getMessageDispatcherConcurrency

public int getMessageDispatcherConcurrency()

Gets the level of concurrency to use when accessing the message dispatcher cache.

Returns:

The level of concurrency for this service's message dispatcher.

equals

public boolean equals(Object underTest)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object