Package org.apereo.cas.configuration.model.support.firebase

Class GoogleFirebaseCloudMessagingProperties

java.lang.Object

org.apereo.cas.configuration.model.support.firebase.GoogleFirebaseCloudMessagingProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-support-notifications-fcm")
public class GoogleFirebaseCloudMessagingProperties
extends Object
implements Serializable

This is GoogleFirebaseCloudMessagingProperties.

Since:

6.3.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
GoogleFirebaseCloudMessagingProperties()

Method Summary

Modifier and Type	Method	Description
String	getDatabaseUrl()	Firebase database url.
String	getRegistrationTokenAttributeName()	The principal attribute name that contains the registration token for the user.
List<String>	getScopes()	Required scopes to properly communicate with the firebase cloud.
SpringResourceProperties	getServiceAccountKey()	Path to the service account key json file.
GoogleFirebaseCloudMessagingProperties	setDatabaseUrl(String databaseUrl)	Firebase database url.
GoogleFirebaseCloudMessagingProperties	setRegistrationTokenAttributeName(String registrationTokenAttributeName)	The principal attribute name that contains the registration token for the user.
GoogleFirebaseCloudMessagingProperties	setScopes(List<String> scopes)	Required scopes to properly communicate with the firebase cloud.
GoogleFirebaseCloudMessagingProperties	setServiceAccountKey(SpringResourceProperties serviceAccountKey)	Path to the service account key json file.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GoogleFirebaseCloudMessagingProperties

public GoogleFirebaseCloudMessagingProperties()

Method Details

getRegistrationTokenAttributeName

public String getRegistrationTokenAttributeName()

The principal attribute name that contains the registration token for the user. Registration tokens that are provided by clients during the handshake process should be stored on the server, and made available to CAS as a principal attribute.

getServiceAccountKey

public SpringResourceProperties getServiceAccountKey()

Path to the service account key json file. This can optional if you set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the file path of the JSON file that contains your service account key. If this is undefined, the property value will be used instead.

getDatabaseUrl

public String getDatabaseUrl()

Firebase database url.

getScopes

public List<String> getScopes()

Required scopes to properly communicate with the firebase cloud.

setRegistrationTokenAttributeName

public GoogleFirebaseCloudMessagingProperties setRegistrationTokenAttributeName(String registrationTokenAttributeName)

The principal attribute name that contains the registration token for the user. Registration tokens that are provided by clients during the handshake process should be stored on the server, and made available to CAS as a principal attribute.

Returns:

this.

setServiceAccountKey

public GoogleFirebaseCloudMessagingProperties setServiceAccountKey(SpringResourceProperties serviceAccountKey)

Path to the service account key json file. This can optional if you set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the file path of the JSON file that contains your service account key. If this is undefined, the property value will be used instead.

Returns:

this.

setDatabaseUrl

public GoogleFirebaseCloudMessagingProperties setDatabaseUrl(String databaseUrl)

Firebase database url.

Returns:

this.

setScopes

public GoogleFirebaseCloudMessagingProperties setScopes(List<String> scopes)

Required scopes to properly communicate with the firebase cloud.

Returns:

this.