EASP API 7.15.0

net.juniper.smgt.ent.im
Interface VPN

All Superinterfaces:
Persistent

public interface VPN
extends Persistent

An instance of VPN represents one of the umcVPN entries in LDAP directory.


Method Summary
 void export(java.lang.String clientId)
          Export the VPN to a extranet client.
 java.util.Collection getExtranetClientIds()
          Return a Collection of ids of this VPN?s importers.
 java.lang.String getSubscriberId()
          returns the id of the container subscirber
 void setDescription(java.lang.String description)
          Set the description of this VPN.
 void unexport(java.lang.String clientId, java.lang.String vpnSubstitutionName)
          Unexport the VPN from a client.
 
Methods inherited from interface net.juniper.smgt.ent.im.Persistent
addListener, delListener, getAttribute, getDisplayName, getId, getName, setAttribute, setAttribute, setDisplayName
 

Method Detail

setDescription

void setDescription(java.lang.String description)
                    throws CommunicationException,
                           AccessControlException,
                           ViolateSchemaException
Set the description of this VPN. Need login manager privilege checking.

Parameters:
description - The new values for the description attribute.
Throws:
CommunicationException - Thrown if there is a problem communicating with the directory.
AccessControlException - Thrown if the current manager does not have write access for the named attribute.
ViolateSchemaException - Thrown if this object's LDAP schema does not allow the given attribute or if multiple values are given for a single-valued attribute.

getExtranetClientIds

java.util.Collection getExtranetClientIds()
                                          throws CommunicationException,
                                                 AccessControlException
Return a Collection of ids of this VPN?s importers. or empty Collection if this object doesn't have this attribute.

Throws:
CommunicationException - Thrown if there is a problem communicating with the directory.
AccessControlException - Thrown if the current manager does not have permission to access the named attribute.

export

void export(java.lang.String clientId)
            throws UnknownIdentityException,
                   CommunicationException,
                   AccessControlException
Export the VPN to a extranet client.

Parameters:
clientId - The id of the extranet client.
Throws:
CommunicationException - Thrown if there is a problem communicating with the directory.
AccessControlException - Thrown if the current manager does not have write access for the named attribute.
UnknownIdentityException - Thrown if the client entry does not exist in the directory.

unexport

void unexport(java.lang.String clientId,
              java.lang.String vpnSubstitutionName)
              throws UnknownIdentityException,
                     CommunicationException,
                     AccessControlException
Unexport the VPN from a client. Need login manager privilege checking. This method unexports the VPN from the specified subscriber and deactivates all subscriptions to this VPN in that subscriber.

Parameters:
clientId - The id of the extranet client. Subscriptions match the specified service category and
vpnSubstitutionName - the name of a substitution that conveys the vpn id. This parameter is used to help finding subscriptions of this VPN in the specified subscriber.
Throws:
CommunicationException - Thrown if there is a problem communicating with the directory.
AccessControlException - Thrown if the current manager does not have write access for the named attribute.
UnknownIdentityException - Thrown if the client entry does not exist in the directory.

getSubscriberId

java.lang.String getSubscriberId()
                                 throws CommunicationException,
                                        AccessControlException
returns the id of the container subscirber

Throws:
CommunicationException - Thrown if there is a problem communicating with the directory.
AccessControlException - Thrown if the current manager does not have permission to access the named attribute.

EASP API 7.15.0