Skip navigation links

Oracle Communications Services Gatekeeper Java API Reference
6.0

E55513-02


oracle.ocsg.subscriber
Class SubscriberManager

java.lang.Object
  extended byoracle.ocsg.subscriber.SubscriberManager


public abstract class SubscriberManager
extends Object

Field Summary
static String DEFAULT_NAME
           

 

Constructor Summary
SubscriberManager()
           

 

Method Summary
abstract  Subscriber authenticate(String addressOrLoginId, String password)
          Authenticate a subscriber.
abstract  Set expandGroupMembers(String address)
          Expand a subscriber group into individual subscribers.
abstract  Set expandGroupMembers(Subscriber subscriber)
          Expand a subscriber group into individual subscribers.
abstract  Set expandGroupMembersRecursion(String address)
          Expand a subscriber group into individual subscribers.
abstract  Set expandGroupMembersRecursion(Subscriber subscriber)
          Expand a subscriber group into individual subscribers.
static SubscriberManager getInstance()
           
static SubscriberManager getInstance(String name)
           
abstract  boolean hasSubscriber(String address)
          Check if the address is a subscriber.
abstract  boolean isGroupAddress(String address)
           
static void registerInstance(String name, SubscriberManager instance)
          Register a subscriber manager instance.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

DEFAULT_NAME

public static final String DEFAULT_NAME
See Also:
Constant Field Values

Constructor Detail

SubscriberManager

public SubscriberManager()

Method Detail

authenticate

public abstract Subscriber authenticate(String addressOrLoginId,
                                        String password)
                                 throws SubscriberException
Authenticate a subscriber.
Parameters:
addressOrLoginId - Address of login ID of subscriber
password - Password of subscriber.
Returns:
the subscriber or null
Throws:
SubscriberException

expandGroupMembers

public abstract Set expandGroupMembers(String address)
Expand a subscriber group into individual subscribers. If the specified address is not a group address, the API is returns the subscriber directly. if the group member is again a group, it will not be expanded.
Parameters:
address - of group
Returns:
all members in this group

expandGroupMembers

public abstract Set expandGroupMembers(Subscriber subscriber)
Expand a subscriber group into individual subscribers. If the specified parameter is not a group address, return the subscriber directly. If the group member is itself a group, that group will not be expanded.
Parameters:
subscriber -
Returns:
all members in this group

expandGroupMembersRecursion

public abstract Set expandGroupMembersRecursion(String address)
Expand a subscriber group into individual subscribers. If the specified address is not a group address, return the subscriber directly. If the group member is itself a group, that group will also be expanded until there are no groups in the list.
Parameters:
address - address
Returns:
all scalar members in this group;

expandGroupMembersRecursion

public abstract Set expandGroupMembersRecursion(Subscriber subscriber)
Expand a subscriber group into individual subscribers. If the specified parameter is not a group address, return the subscriber directly. If the group member is itself a group, that group will be expanded until there are no groups in the list.
Parameters:
subscriber - subscriber
Returns:
all scalar members in this group

getInstance

public static SubscriberManager getInstance()

getInstance

public static SubscriberManager getInstance(String name)

hasSubscriber

public abstract boolean hasSubscriber(String address)
Check if the address is a subscriber.
Parameters:
address - Address of end user
Returns:
result

isGroupAddress

public abstract boolean isGroupAddress(String address)

registerInstance

public static void registerInstance(String name,
                                    SubscriberManager instance)
Register a subscriber manager instance. Use registerInstance("default", xxx) to overwrite the default subscriber manager behavior.
Parameters:
name -
instance -

Skip navigation links

Oracle Communications Services Gatekeeper Java API Reference
6.0

E55513-02


Copyright © 2008, 2015, Oracle and/or its affiliates. All rights reserved.