Module com.zerodeplibs.webpush

Package com.zerodeplibs.webpush.httpclient

Class PreparerBuilder.RequestPreparationInfo

java.lang.Object

com.zerodeplibs.webpush.httpclient.PreparerBuilder.RequestPreparationInfo

Enclosing class:

PreparerBuilder<T>

public static class PreparerBuilder.RequestPreparationInfo
extends Object

Represents information which is required for an application to request the delivery of a push message.

Instances of this class are constructed with (and therefore hold) a push service url, values for HTTP header fields and an encrypted request body(if a push message is specified).

Thread Safety:

Instances of this class are immutable. So they are thread-safe.

Author:

Tomoki Sato

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Compares the given object with this object based on their properties.
Optional<EncryptedPushMessage>	getEncryptedPushMessage()	Gets the EncryptedPushMessage.
String	getEndpointUrl()	Gets the endpoint url to which a push message is send.
Optional<String>	getTopic()	Gets the topic.
String	getTtlString()	Gets the value of TTL.
String	getUrgency()	Gets the value of Urgency.
String	getVapidHeader()	Gets the credential for VAPID.
int	hashCode()	Returns the hash code value for this object based on its properties.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getEndpointUrl

public String getEndpointUrl()

Gets the endpoint url to which a push message is send.

Returns:

the endpoint url.

getVapidHeader

public String getVapidHeader()

Gets the credential for VAPID. The returned value should be used to set the Authorization HTTP header field.

Returns:

the credential for VAPID.

See Also:

VAPIDKeyPair.generateAuthorizationHeaderValue(VAPIDJWTParam)

getEncryptedPushMessage

public Optional<EncryptedPushMessage> getEncryptedPushMessage()

Gets the EncryptedPushMessage. If a push message is specified at the time of the creation, an Optional containing the EncryptedPushMessage is returned.

Returns:

an Optional that may or may not contain the EncryptedPushMessage.

getTtlString

public String getTtlString()

Gets the value of TTL. The returned value should be used to set the TTL HTTP header field.

Returns:

the value of TTL.

getUrgency

public String getUrgency()

Gets the value of Urgency. The returned value should be used to set the Urgency HTTP header field.

Returns:

the value of Urgency.

getTopic

public Optional<String> getTopic()

Gets the topic. The value should be used to set the Topic HTTP header field. If a topic is specified at the time of the creation, an Optional containing the topic is returned.

Returns:

an Optional that may or may not contain the topic.

equals

public boolean equals(Object o)

Compares the given object with this object based on their properties.

Overrides:

equals in class Object

Parameters:

o - an object.

Returns:

true if the given object is equal to this object

hashCode

public int hashCode()

Returns the hash code value for this object based on its properties.

Overrides:

hashCode in class Object

Returns:

the hash code value for this object.

toString

public String toString()

Overrides:

toString in class Object