Skip navigation links
AeroGear WebPush Server API 1.0.0-alpha.1
A C D E G H I M N O P R S T U V W 

A

AggregateSubscription - Interface in org.jboss.aerogear.webpush
 
AggregateSubscription.Entry - Interface in org.jboss.aerogear.webpush
 
aggregateUri() - Method in interface org.jboss.aerogear.webpush.Registration
The URI used by devices to create aggreate/batch subscriptions.

C

cert() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
Returns the server certificate file.
config() - Method in interface org.jboss.aerogear.webpush.WebPushServer
Returns the configuration for this WebPush server.

D

DataStore - Interface in org.jboss.aerogear.webpush.datastore
Handles the storing of subscriptions for a WebPush Server implementation.

E

endpoint() - Method in interface org.jboss.aerogear.webpush.AggregateSubscription.Entry
The endpoint for the subscription
endpoint() - Method in interface org.jboss.aerogear.webpush.Subscription
Returns the endpoint token for this subscription.
endpointHost() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
The externally available host that this server is reachable by.
endpointPort() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
The externally available port that this server is reachable by.
expires() - Method in interface org.jboss.aerogear.webpush.AggregateSubscription.Entry
Determines when the provided subscription becomes invalid.

G

getMessage(String) - Method in interface org.jboss.aerogear.webpush.WebPushServer
Handles the retrieval of a subscriptions's message.
getPrivateKeySalt() - Method in interface org.jboss.aerogear.webpush.datastore.DataStore
Returns the server's private key salt.
getRegistration(String) - Method in interface org.jboss.aerogear.webpush.datastore.DataStore
Returns the Registration for the passed-in id.
getSubscriptions(String) - Method in interface org.jboss.aerogear.webpush.datastore.DataStore
Returns registrations for a certain registration.

H

host() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
The host that this server will bind to.

I

id() - Method in interface org.jboss.aerogear.webpush.Registration
A globally unique identifier for this registration.
id() - Method in interface org.jboss.aerogear.webpush.Subscription
Returns the id for this subscription.

M

message() - Method in interface org.jboss.aerogear.webpush.Subscription
The notification/message for this subscription.
MESSAGE_MAX_LOWER_BOUND - Static variable in interface org.jboss.aerogear.webpush.WebPushServerConfig
 
messageMaxAge() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
Returns the maximum age that a message will be stored for.
messageMaxSize() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
Returns the maximum size of a message that this server can handle.
monitor(String, String) - Method in interface org.jboss.aerogear.webpush.WebPushServer
Handles device monitorURI requests which are a signal to the server to begin delivering push notification/messages to the client.

N

newSubscription(String) - Method in interface org.jboss.aerogear.webpush.WebPushServer
Handles the creation of new subscriptions for a registration.

O

org.jboss.aerogear.webpush - package org.jboss.aerogear.webpush
 
org.jboss.aerogear.webpush.datastore - package org.jboss.aerogear.webpush.datastore
 

P

password() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
The password for the private key.
port() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
The port that this server will bind to.
privateKey() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
Returns the server private key file.
protocol() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
Returnes the WebPushServerConfig.Protocol to use.
pubkey() - Method in interface org.jboss.aerogear.webpush.AggregateSubscription.Entry
The public key used for encrypting on this subscription.

R

register() - Method in interface org.jboss.aerogear.webpush.WebPushServer
Registers a device with this server as per
Registration - Interface in org.jboss.aerogear.webpush
Represents a client registration in the WebPush protocol.
registration(String) - Method in interface org.jboss.aerogear.webpush.WebPushServer
Returns the Registration for the specified id.
Registration.Resource - Enum in org.jboss.aerogear.webpush
 
Registration.WebLink - Enum in org.jboss.aerogear.webpush
 
registrationId() - Method in interface org.jboss.aerogear.webpush.Subscription
The registration that this subscription belongs to.
registrationMaxAge() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
Returns the maximum age for a registration
removeChannel(Subscription) - Method in interface org.jboss.aerogear.webpush.datastore.DataStore
Remove a Subscription from the underlying storage system.
removeSubscription(Subscription) - Method in interface org.jboss.aerogear.webpush.WebPushServer
Removes the specified subscription.
resourceName() - Method in enum org.jboss.aerogear.webpush.Registration.Resource
 

S

saveChannel(Subscription) - Method in interface org.jboss.aerogear.webpush.datastore.DataStore
Saves a Subscription to the underlying storage system.
savePrivateKeySalt(byte[]) - Method in interface org.jboss.aerogear.webpush.datastore.DataStore
Saves the server's private key salt.
saveRegistration(Registration) - Method in interface org.jboss.aerogear.webpush.datastore.DataStore
Saves a Registration to the underlying storage system.
setMessage(String, Optional<String>) - Method in interface org.jboss.aerogear.webpush.WebPushServer
Set the notifcation/message for a subscription.
subscribeUri() - Method in interface org.jboss.aerogear.webpush.Registration
The URI used by devices to create new subscriptions
Subscription - Interface in org.jboss.aerogear.webpush
 
subscription(String) - Method in interface org.jboss.aerogear.webpush.WebPushServer
Retrieves a subscriptions.
subscriptionMaxAge() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
Returns the maximum age for a subscription.
subscriptions() - Method in interface org.jboss.aerogear.webpush.AggregateSubscription
 

T

toString() - Method in enum org.jboss.aerogear.webpush.Registration.WebLink
 

U

uri() - Method in interface org.jboss.aerogear.webpush.Registration
The URI representing this registration.
useEndpointTls() - Method in interface org.jboss.aerogear.webpush.WebPushServerConfig
Determins whether transport layer security is in use.

V

valueOf(String) - Static method in enum org.jboss.aerogear.webpush.Registration.Resource
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.aerogear.webpush.Registration.WebLink
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.aerogear.webpush.WebPushServerConfig.Protocol
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jboss.aerogear.webpush.Registration.Resource
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.aerogear.webpush.Registration.WebLink
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.aerogear.webpush.WebPushServerConfig.Protocol
Returns an array containing the constants of this enum type, in the order they are declared.

W

weblink(String) - Method in enum org.jboss.aerogear.webpush.Registration.WebLink
 
WebPushServer - Interface in org.jboss.aerogear.webpush
A Java implementation of WebPush Server.
WebPushServerConfig - Interface in org.jboss.aerogear.webpush
Configuration settings for WebPush server
WebPushServerConfig.Protocol - Enum in org.jboss.aerogear.webpush
 
A C D E G H I M N O P R S T U V W 
Skip navigation links
AeroGear WebPush Server API 1.0.0-alpha.1

Copyright © 2015 JBoss by Red Hat. All Rights Reserved.