org.mobicents.csapi.jr.slee.cm
Interface IpEnterpriseNetworkSiteConnection

All Superinterfaces:

IpEnterpriseNetworkConnection, IpServiceConnection

public interface IpEnterpriseNetworkSiteConnection
extends IpEnterpriseNetworkConnection

This interface stores enterprise network site information maintained by the provider.

Method Summary

TpIPSubnet	getIPSubnet() This method is used to get IP subnet information for this site.
TpIPSubnet	getSAPIPSubnet(java.lang.String sapID) This method is used to get the IP address of the SAP on the enterprise network.
java.lang.String[]	getSAPList() This method is used to get the list of SAP IDs of the enterprise VPN (i.e., on the provider network) that have previously been established for this site with the provider network.
java.lang.String	getSiteDescription() This method is used to get the description associated with this site.
java.lang.String	getSiteID() This method is used to get the site ID for this site.
java.lang.String	getSiteLocation() This method is used to get the site location.

Methods inherited from interface org.mobicents.csapi.jr.slee.cm.IpEnterpriseNetworkConnection

getSite, getSiteList, getVPrN

Methods inherited from interface org.mobicents.csapi.jr.slee.IpServiceConnection

closeConnection

Method Detail

getSAPList

java.lang.String[] getSAPList()
                              throws TpCommonExceptions,
                                     P_UNKNOWN_SAPS,
                                     javax.slee.resource.ResourceException

This method is used to get the list of SAP IDs of the enterprise VPN (i.e., on the provider network) that have previously been established for this site with the provider network.

Returns:

sapList : This parameter is a list of SAP IDs. This SAP ID can be used as an endpoint of a provisioned virtual provisioned pipe (VPrP). If no SAPs are found for this site, then P_UNKNOWN_SAPS exception is raised.

Throws:

TpCommonExceptions

P_UNKNOWN_SAPS

javax.slee.resource.ResourceException

getSiteID

java.lang.String getSiteID()
                           throws TpCommonExceptions,
                                  P_UNKNOWN_SITE_ID,
                                  javax.slee.resource.ResourceException

This method is used to get the site ID for this site.

Returns:

siteID : This parameter holds the value for the site ID. If no site ID is found for this site, then P_UNKNOWN_SITE_ID exception is raised.

Throws:

TpCommonExceptions

P_UNKNOWN_SITE_ID

javax.slee.resource.ResourceException

getSiteLocation

java.lang.String getSiteLocation()
                                 throws TpCommonExceptions,
                                        P_UNKNOWN_SITE_LOCATION,
                                        javax.slee.resource.ResourceException

This method is used to get the site location.

Returns:

siteLocation : This parameter holds the value for the site location. If no site location is found for this site, then P_UNKNOWN_SITE_LOCATION exception is raised.

Throws:

TpCommonExceptions

P_UNKNOWN_SITE_LOCATION

javax.slee.resource.ResourceException

getSiteDescription

java.lang.String getSiteDescription()
                                    throws TpCommonExceptions,
                                           P_UNKNOWN_SITE_DESCRIPTION,
                                           javax.slee.resource.ResourceException

This method is used to get the description associated with this site.

Returns:

siteDescription : This parameter is a string that holds the site description. If no description is found for this site, then P_UNKNOWN_SITE_DESCRIPTION exception is raised.

Throws:

TpCommonExceptions

P_UNKNOWN_SITE_DESCRIPTION

javax.slee.resource.ResourceException

getIPSubnet

TpIPSubnet getIPSubnet()
                       throws TpCommonExceptions,
                              P_UNKNOWN_IPSUBNET,
                              javax.slee.resource.ResourceException

This method is used to get IP subnet information for this site.

Returns:

ipSubnet : This parameter lists the subnet information. If no IP Subnet information is found for this site, then a P_UNKNOWN_IPSUBNET exception is raised.

Throws:

TpCommonExceptions

P_UNKNOWN_IPSUBNET

javax.slee.resource.ResourceException

getSAPIPSubnet

TpIPSubnet getSAPIPSubnet(java.lang.String sapID)
                          throws TpCommonExceptions,
                                 P_ILLEGAL_SITE_ID,
                                 P_UNKNOWN_SAP,
                                 P_UNKNOWN_IPSUBNET,
                                 javax.slee.resource.ResourceException

This method is used to get the IP address of the SAP on the enterprise network.

Parameters:

sapID - This parameter holds the IP address information for the SAP. - If the string representation of the sapID does not obey the rules for site identification, then a P_ILLEGAL_SITE_ID exception is raised. - If the site ID representation is legal but there is no site with this ID, then P_UNKNOWN_SAP exception is raised. - If no IP Subnet information is found for this SAP, then a P_UNKNOWN_IPSUBNET exception is raised.

Returns:

ipSubnet : This parameter holds the IP address information for the SAP. This TpIPSubnet data type follows the DMTF CIM specification for IP sub-net.

Throws:

TpCommonExceptions

P_ILLEGAL_SITE_ID

P_UNKNOWN_SAP

P_UNKNOWN_IPSUBNET

javax.slee.resource.ResourceException