org.jboss.aerogear.simplepush.server

Interface SimplePushServerConfig

public interface SimplePushServerConfig

Configuration settings for SimplePush server

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENDPOINT_URL_PREFIX The default prefix for the the notification endpoint url.

Method Summary

Methods

Modifier and Type	Method and Description
long	acknowledmentInterval() Returns the acknowledgement interval.
String	endpointHost() The externally available host that this server is reachable by.
int	endpointPort() The externally available port that this server is reachable by.
String	endpointPrefix() Returns the endpoint url prefix for this SimplePush server.
String	endpointUrl() Returns the notification endpoint url prefix for this SimplePush server.
String	host() The host that this server will bind to.
int	notifierMaxThreads() Returns the maxium number of threads that will be used for handling notifications.
String	password() The password for the private key.
int	port() The port that this server will bind to.
boolean	useEndpointTls() Determins whether transport layer security is in use.
long	userAgentReaperTimeout() Returns the UserAgent reaper time out.

Field Detail

DEFAULT_ENDPOINT_URL_PREFIX

static final String DEFAULT_ENDPOINT_URL_PREFIX

The default prefix for the the notification endpoint url. This prefix will be used and returned to the client to enable the client to PUT notifications.

See Also:

Constant Field Values

Method Detail

host

String host()

The host that this server will bind to.

Returns:

String the host.

port

int port()

The port that this server will bind to.

Returns:

port the port.

useEndpointTls

boolean useEndpointTls()

Determins whether transport layer security is in use.

Returns:

true if transport layer security is in use.

password

String password()

The password for the private key.

Returns:

String[] password used for generating the server's private key.

endpointPrefix

String endpointPrefix()

Returns the endpoint url prefix for this SimplePush server. This will get the channelId appended to it.

Returns:

String the endpoint url prefix.

endpointUrl

String endpointUrl()

Returns the notification endpoint url prefix for this SimplePush server. This will be the in the format: protocol://endpointHost:endpointPort/endpointPrefix

Returns:

String the notification url.

endpointHost

String endpointHost()

The externally available host that this server is reachable by.

Returns:

String the host.

endpointPort

int endpointPort()

The externally available port that this server is reachable by.

Returns:

port the port.

userAgentReaperTimeout

long userAgentReaperTimeout()

Returns the UserAgent reaper time out. This is the amount of time which a UserAgent can be inactive after which it will be removed from the system.

Returns:

long the timeout in milliseconds.

acknowledmentInterval

long acknowledmentInterval()

Returns the acknowledgement interval. This is the interval time for resending non acknowledged notifications.

Returns:

long the interval in milliseconds.

notifierMaxThreads

int notifierMaxThreads()

Returns the maxium number of threads that will be used for handling notifications.

Returns:

int the maximum number of threads allowed to be created.