net.juniper.smgt.ent.im
Interface Subscriber

All Superinterfaces:

Managers, Persistent, Substitutions

All Known Subinterfaces:

Access, Enterprise, Folder, Retailer, Site

public interface Subscriber

extends Substitutions, Persistent, Managers

This interface provides the functionality common to the three types of Subscribers: Enterprises, Sites, and Accesses.

Method Summary

Collection	acquireServices() Returns a Collection of the acquired Services that this subscriber can subscribe to.
void	clearImportedVPNCache() Clear the cache of imported VPN in this subscriber.
PersistentIterator	getAccesses() Returns a iterator over the Accesses in this Subscriber.
PersistentIterator	getChildren() Returns an iterator over the Subscriber children of this Subscriber.
PersistentIterator	getEnterprises() Returns an iterator over the Enterprises that is under (for Retailer) or directly under (for Enterprise, Site, Access and Folder) this Subscriber
PersistentIterator	getFolders() Returns a iterator over the Folders in this Subscriber.
Collection	getImportedVPNNames() Return a Collection of names of VPNs that are imported by this Subscriber.
PersistentIterator	getLocalVPNs() Return a PersistentIterator over all the contained VPNs.
Subscriber	getParent() Returns the parent of this Subscriber, or null if this Subscriber is an Enterprise (i.e. if it is the root of a Subscriber tree).
Service	getService(String serviceName) Returns the Service with the given name, if it is a service to which this Subscriber can be subscribed, otherwise returns null.
PersistentIterator	getServices() Deprecated. use acquireServices() instead.
Collection	getSessions() Returns all the Sessions associated with all the Subscriptions of this Subscriber.
PersistentIterator	getSites() Returns a iterator over the Sites in this Subscriber.
Subscription	getSubscription(String serviceName) Returns this Subscriber's default Subscription to the Service with the specified name.
Subscription	getSubscription(String serviceName, String subscriptionName) Returns this Subscriber's Subscription named by subscriptionName to the Service with the specified name.
PersistentIterator	getSubscriptions() Returns an iterator over all the Subscriptions that belong to this Subscriber.
Collection	getSubscriptions(String serviceName) Returns a Collection of this Subscriber's Subscriptions to the named Service.
boolean	isSubscribed(String serviceName) Returns true only if this Subscriber has a Subscription to the specified Service.
boolean	isSubscribed(String serviceName, String subscriptionName) Returns true only if this Subscriber has a Subscription with the specified name to the specified Service.
Subscription	subscribe(String serviceName) Creates a default subscription for this Subscriber to the Service specified by serviceName.
Subscription	subscribe(String serviceName, String subscriptionName) Subscribes this Subscriber to the Service specified by serviceName and names the subscription with subscriptionName.
void	unsubscribe(String serviceName) Deletes the default Subscription to the specified Service from this Subscriber.
void	unsubscribe(String serviceName, String subscriptionName) Deletes the Subscription identified by subscriptionName to the specified Service from this Subscriber.

Methods inherited from interface net.juniper.smgt.ent.im.Substitutions

delSubstitution, getDefaultedVariables, getFixedVariables, getFreeVariables, getSubstitution, getSubstitutionVariableNames, hasSubstitution, putSubstitution

Methods inherited from interface net.juniper.smgt.ent.im.Persistent

addListener, delListener, getAttribute, getDisplayName, getId, getName, setAttribute, setAttribute, setDisplayName

Methods inherited from interface net.juniper.smgt.ent.im.Managers

addManager, delManager, getManager, getManagers

Method Detail

getParent

public Subscriber getParent()
                     throws CommunicationException,
                            AccessControlException

Returns the parent of this Subscriber, or null if this Subscriber is an Enterprise (i.e. if it is the root of a Subscriber tree).

Throws:

CommunicationException - Thrown if there is a problem communicationg with the directory.

AccessControlException - Thrown if the currently bound manager does not have access to the parent Subscriber.

getChildren

public PersistentIterator getChildren()
                               throws CommunicationException

Returns an iterator over the Subscriber children of this Subscriber. If this Subscriber is an Access, this method returns an empty iterator. If this Subscriber is a Site, this method returns an iterater over the Accesses that belong to the Site. If this Subscriber is an Enterprise, this method returns an iterator over the Sites and Accesses that belong to the Enterprise (but only those Accesses that exist immediately underneath the Enterise; not those that exist underneath the Enterprise's Sites).

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

getServices

public PersistentIterator getServices()
                               throws CommunicationException

Deprecated. use acquireServices() instead.

Returns a PersistenetIterator over the global Services.

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

acquireServices

public Collection acquireServices()
                           throws CommunicationException

Returns a Collection of the acquired Services that this subscriber can subscribe to. The returned Services are acquired through service scopes.

Returns:

java.util.Collection.

CommunicationException

getService

public Service getService(String serviceName)
                   throws UnknownIdentityException,
                          CommunicationException

Returns the Service with the given name, if it is a service to which this Subscriber can be subscribed, otherwise returns null.

Parameters:

serviceName - The name of the desired Service.

UnknownIdentityException

CommunicationException

getSubscriptions

public PersistentIterator getSubscriptions()
                                    throws CommunicationException

Returns an iterator over all the Subscriptions that belong to this Subscriber. This includes only those Subscriptions stored immediately below this Subscriber in LDAP, and not those Subscriptions stored immediately below any ancestor Subscribers of this Subscriber in LDAP.

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

getSubscriptions

public Collection getSubscriptions(String serviceName)
                            throws CommunicationException

Returns a Collection of this Subscriber's Subscriptions to the named Service.

Parameters:

serviceName - The name of the Service for which Subscriptions should be returned.

Returns:

A Collection of the subscriptions. If there is no subscriptions of the specified service, an empty Collection is returned.

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

getSubscription

public Subscription getSubscription(String serviceName)
                             throws UnknownIdentityException,
                                    CommunicationException

Returns this Subscriber's default Subscription to the Service with the specified name. This is equivalent to getSubscription(serviceName, null).

Parameters:

serviceName - The name of a Service to which this Subscriber is subscribed.

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

UnknownIdentityException - Thrown if there is no Subscription to the specified service.

getSubscription

public Subscription getSubscription(String serviceName,
                                    String subscriptionName)
                             throws UnknownIdentityException,
                                    CommunicationException

Returns this Subscriber's Subscription named by subscriptionName to the Service with the specified name.

Parameters:

serviceName - The name of a Service to which this Subscriber is subscribed.

subscriptionName - The name of the subscription, or null if it is a default subscription

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

UnknownIdentityException - Thrown if there is no Subscription to the specified service.

getSessions

public Collection getSessions()
                       throws CommunicationException,
                              AccessControlException

Returns all the Sessions associated with all the Subscriptions of this Subscriber. The collection will be empty unless the Subscriber is a leaf node (e.g. an Access) in the Subscriber tree hierarchy.

Returns:

A Collection of Session objects.

Throws:

CommunicationException - if there is a problem communicating with the Directory.

AccessControlException - Thrown if the currently bound manager does not have access permission to get the Sessions

subscribe

public Subscription subscribe(String serviceName)
                       throws UnknownIdentityException,
                              CommunicationException,
                              DuplicateNameException,
                              AccessControlException

Creates a default subscription for this Subscriber to the Service specified by serviceName. This is equivalent to subscribe(serviceName, null).

Parameters:

serviceName - The name of the Service to which this Subscriber should be subscribed.

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

UnknownIdentityException - Thrown if the specified Service is not available to be subscribed to by this Subscriber.

DuplicateNameException - Thrown if the Subscriber already has a Subscription to the specified service.

AccessControlException - Thrown if the currently bound Manager is not allowed to create Subscritions for this Subscriber.

subscribe

public Subscription subscribe(String serviceName,
                              String subscriptionName)
                       throws UnknownIdentityException,
                              CommunicationException,
                              DuplicateNameException,
                              AccessControlException

Subscribes this Subscriber to the Service specified by serviceName and names the subscription with subscriptionName. The subscriptionName must be unique in the subscriber's subscriptions of the service specified by serviceName

Parameters:

serviceName - The name of the Service to which this Subscriber should be subscribed.

subscriptionName - The name of the subscription, or null if the Subscription is a default subscription.

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

UnknownIdentityException - Thrown if the specified Service is not available to be subscribed to by this Subscriber.

DuplicateNameException - Thrown if the Subscriber already has a Subscription with the specified subscriptionName to the specified service.

AccessControlException - Thrown if the currently bound Manager is not allowed to create Subscritions for this Subscriber.

unsubscribe

public void unsubscribe(String serviceName)
                 throws UnknownIdentityException,
                        CommunicationException,
                        AccessControlException

Deletes the default Subscription to the specified Service from this Subscriber. This is equivalent to unsubscribe(serviceName, null).

Parameters:

serviceName - The name of the Service to which this Subscriber should no longer be subscribed.

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

UnknownIdentityException - Thrown if there is no Subscription to the specified service.

AccessControlException - Thrown if the currently bound Manager is not allowed to delete Subscriptions from this Subscriber.

unsubscribe

public void unsubscribe(String serviceName,
                        String subscriptionName)
                 throws UnknownIdentityException,
                        CommunicationException,
                        AccessControlException

Deletes the Subscription identified by subscriptionName to the specified Service from this Subscriber.

Parameters:

serviceName - The name of the Service to which this Subscriber should no longer be subscribed.

subscriptionName - The name of the subscription, or null if the Subscription is a default subscription.

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

UnknownIdentityException - Thrown if there is no Subscription to the specified service.

AccessControlException - Thrown if the currently bound Manager is not allowed to delete Subscriptions from this Subscriber.

isSubscribed

public boolean isSubscribed(String serviceName)
                     throws CommunicationException

Returns true only if this Subscriber has a Subscription to the specified Service.

Parameters:

serviceName - The name of the Service.

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

isSubscribed

public boolean isSubscribed(String serviceName,
                            String subscriptionName)
                     throws CommunicationException

Returns true only if this Subscriber has a Subscription with the specified name to the specified Service.

Parameters:

serviceName - The name of the Service.

subscriptionName - The name of the subscription.

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

getAccesses

public PersistentIterator getAccesses()
                               throws CommunicationException

Returns a iterator over the Accesses in this Subscriber.

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

getEnterprises

public PersistentIterator getEnterprises()
                                  throws CommunicationException

Returns an iterator over the Enterprises that is under (for Retailer) or directly under (for Enterprise, Site, Access and Folder) this Subscriber

Throws:

CommunicationException - Thrown if there is a problem communicating with the directory.

getFolders

public PersistentIterator getFolders()
                              throws CommunicationException

Returns a iterator over the Folders in this Subscriber.

Throws:

CommunicationException - Thrown if there is a problem communicating with the SSC's LDAP directory.

getSites

public PersistentIterator getSites()
                            throws CommunicationException

Returns a iterator over the Sites in this Subscriber.

Throws:

CommunicationException - Thrown if there is a problem communicating with the SSC's LDAP directory.

getLocalVPNs

public PersistentIterator getLocalVPNs()
                                throws CommunicationException

Return a PersistentIterator over all the contained VPNs.

Throws:

CommunicationException - Thrown if there is a problem communicating with the SDX's LDAP directory.

getImportedVPNNames

public Collection getImportedVPNNames()
                               throws CommunicationException,
                                      AccessControlException

Return a Collection of names of VPNs that are imported by this Subscriber.

Throws:

CommunicationException - Thrown if there is a problem communicating with the SDX's LDAP directory.

AccessControlException - Thrown if the currently bound Manager is not allowed to read the attribute.

clearImportedVPNCache

public void clearImportedVPNCache()
                           throws CommunicationException

Clear the cache of imported VPN in this subscriber.

Throws:

CommunicationException - Thrown if there is a problem communicating with the SDX's LDAP directory.