com.okta.sdk.impl.resource.role

Class DefaultSubscription

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.sdk.impl.resource.AbstractInstanceResource<Subscription>

com.okta.sdk.impl.resource.role.DefaultSubscription

All Implemented Interfaces:

ExtensibleResource, PropertyRetriever, Resource, Subscription, Saveable<Subscription>, Map<String,Object>

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2022-09-29T14:57:31.808Z")
public class DefaultSubscription
extends AbstractInstanceResource<Subscription>
implements Subscription

Subscription

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

properties

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
DefaultSubscription(InternalDataStore dataStore)
DefaultSubscription(InternalDataStore dataStore, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
List<String>	getChannels()
Map<String,Object>	getLinks()
NotificationType	getNotificationType()
Map<String,Property>	getPropertyDescriptors()
Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
Subscription	getRoleSubscriptionByNotificationType(String roleTypeOrRoleId, String notificationType) Get subscriptions of a Custom Role with a specific notification type When roleType Get subscriptions of a Role with a specific notification type.
SubscriptionStatus	getStatus()
Subscription	getUserSubscriptionByNotificationType(String userId, String notificationType) Get the subscription of a User with a specific notification type Get the subscriptions of a User with a specific notification type.
SubscriptionList	listRoleSubscriptions(String roleTypeOrRoleId) List all subscriptions of a Custom Role When roleType List all subscriptions of a Role.
SubscriptionList	listUserSubscriptions(String userId) List subscriptions of a User List subscriptions of a User.
Subscription	setChannels(List<String> channels)
Subscription	setNotificationType(NotificationType notificationType)
Subscription	setStatus(SubscriptionStatus status)
void	subscribeRoleSubscriptionByNotificationType(String roleTypeOrRoleId, String notificationType) Subscribe a Custom Role to a specific notification type When roleType Subscribes a Role to a specific notification type.
void	subscribeUserSubscriptionByNotificationType(String userId, String notificationType) Subscribe to a specific notification type Subscribes a User to a specific notification type.
void	unsubscribeRoleSubscriptionByNotificationType(String roleTypeOrRoleId, String notificationType) Unsubscribe a Custom Role from a specific notification type When roleType Unsubscribes a Role from a specific notification type.
void	unsubscribeUserSubscriptionByNotificationType(String userId, String notificationType) Unsubscribe from a specific notification type Unsubscribes a User from a specific notification type.

Methods inherited from class com.okta.sdk.impl.resource.AbstractInstanceResource

delete, save

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

DefaultSubscription

public DefaultSubscription(InternalDataStore dataStore)

DefaultSubscription

public DefaultSubscription(InternalDataStore dataStore,
                           Map<String,Object> properties)

Method Detail

getPropertyDescriptors

public Map<String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getResourceClass

public Class<? extends Resource> getResourceClass()

Description copied from class: AbstractInstanceResource

Returns the class this resource represents. This is used when you need to figure out what the main type of Resource this object is. For example, DefaultFoo, ImplFoo, and SuperFoo may all represent the Resource of Foo, in this case this method may return Foo.class. (Defaults to getClass().)

Overrides:

getResourceClass in class AbstractInstanceResource<Subscription>

Returns:

The type of resource this class represents.

getLinks

public Map<String,Object> getLinks()

Specified by:

getLinks in interface Subscription

getChannels

public List<String> getChannels()

Specified by:

getChannels in interface Subscription

setChannels

public Subscription setChannels(List<String> channels)

Specified by:

setChannels in interface Subscription

getNotificationType

public NotificationType getNotificationType()

Specified by:

getNotificationType in interface Subscription

setNotificationType

public Subscription setNotificationType(NotificationType notificationType)

Specified by:

setNotificationType in interface Subscription

getStatus

public SubscriptionStatus getStatus()

Specified by:

getStatus in interface Subscription

setStatus

public Subscription setStatus(SubscriptionStatus status)

Specified by:

setStatus in interface Subscription

getUserSubscriptionByNotificationType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2022-09-29T14:57:31.808Z",
           comments="GET - /api/v1/users/{userId}/subscriptions/{notificationType}")
public Subscription getUserSubscriptionByNotificationType(String userId,
                                                                                                                                                                                                                                                                  String notificationType)

Get the subscription of a User with a specific notification type Get the subscriptions of a User with a specific notification type. Only gets subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users.

Specified by:

getUserSubscriptionByNotificationType in interface Subscription

Parameters:

userId - (required)

notificationType - (required)

Returns:

Subscription

subscribeRoleSubscriptionByNotificationType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2022-09-29T14:57:31.808Z",
           comments="POST - /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}/subscribe")
public void subscribeRoleSubscriptionByNotificationType(String roleTypeOrRoleId,
                                                                                                                                                                                                                                                                                     String notificationType)

Subscribe a Custom Role to a specific notification type When roleType Subscribes a Role to a specific notification type. When you change the subscription status of a Role, it overrides the subscription of any individual user of that Role. Else when roleId Subscribes a Custom Role to a specific notification type. When you change the subscription status of a Custom Role, it overrides the subscription of any individual user of that Custom Role.

Specified by:

subscribeRoleSubscriptionByNotificationType in interface Subscription

Parameters:

roleTypeOrRoleId - (required)

notificationType - (required)

subscribeUserSubscriptionByNotificationType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2022-09-29T14:57:31.808Z",
           comments="POST - /api/v1/users/{userId}/subscriptions/{notificationType}/subscribe")
public void subscribeUserSubscriptionByNotificationType(String userId,
                                                                                                                                                                                                                                                                           String notificationType)

Subscribe to a specific notification type Subscribes a User to a specific notification type. Only the current User can subscribe to a specific notification type. An AccessDeniedException message is sent if requests are made from other users.

Specified by:

subscribeUserSubscriptionByNotificationType in interface Subscription

Parameters:

userId - (required)

notificationType - (required)

listRoleSubscriptions

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2022-09-29T14:57:31.808Z",
           comments="GET - /api/v1/roles/{roleTypeOrRoleId}/subscriptions")
public SubscriptionList listRoleSubscriptions(String roleTypeOrRoleId)

List all subscriptions of a Custom Role When roleType List all subscriptions of a Role. Else when roleId List subscriptions of a Custom Role

Specified by:

listRoleSubscriptions in interface Subscription

Parameters:

roleTypeOrRoleId - (required)

Returns:

SubscriptionList

unsubscribeRoleSubscriptionByNotificationType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2022-09-29T14:57:31.808Z",
           comments="POST - /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}/unsubscribe")
public void unsubscribeRoleSubscriptionByNotificationType(String roleTypeOrRoleId,
                                                                                                                                                                                                                                                                                         String notificationType)

Unsubscribe a Custom Role from a specific notification type When roleType Unsubscribes a Role from a specific notification type. When you change the subscription status of a Role, it overrides the subscription of any individual user of that Role. Else when roleId Unsubscribes a Custom Role from a specific notification type. When you change the subscription status of a Custom Role, it overrides the subscription of any individual user of that Custom Role.

Specified by:

unsubscribeRoleSubscriptionByNotificationType in interface Subscription

Parameters:

roleTypeOrRoleId - (required)

notificationType - (required)

getRoleSubscriptionByNotificationType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2022-09-29T14:57:31.808Z",
           comments="GET - /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}")
public Subscription getRoleSubscriptionByNotificationType(String roleTypeOrRoleId,
                                                                                                                                                                                                                                                                            String notificationType)

Get subscriptions of a Custom Role with a specific notification type When roleType Get subscriptions of a Role with a specific notification type. Else when roleId Get subscription of a Custom Role with a specific notification type.

Specified by:

getRoleSubscriptionByNotificationType in interface Subscription

Parameters:

roleTypeOrRoleId - (required)

notificationType - (required)

Returns:

Subscription

unsubscribeUserSubscriptionByNotificationType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2022-09-29T14:57:31.808Z",
           comments="POST - /api/v1/users/{userId}/subscriptions/{notificationType}/unsubscribe")
public void unsubscribeUserSubscriptionByNotificationType(String userId,
                                                                                                                                                                                                                                                                               String notificationType)

Unsubscribe from a specific notification type Unsubscribes a User from a specific notification type. Only the current User can unsubscribe from a specific notification type. An AccessDeniedException message is sent if requests are made from other users.

Specified by:

unsubscribeUserSubscriptionByNotificationType in interface Subscription

Parameters:

userId - (required)

notificationType - (required)

listUserSubscriptions

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2022-09-29T14:57:31.808Z",
           comments="GET - /api/v1/users/{userId}/subscriptions")
public SubscriptionList listUserSubscriptions(String userId)

List subscriptions of a User List subscriptions of a User. Only lists subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users.

Specified by:

listUserSubscriptions in interface Subscription

Parameters:

userId - (required)

Returns:

SubscriptionList