NetOP user guide

Corporate HeadquartersRedback Networks Inc.100 Headquarters DriveSan Jose, CA 95134-1362USAhttp://www.redback.comTel: +1 408 750 5000

NetOp Policy Manager API (Javadoc) Guide

Release 6.1.5Part Number 2/1551-CRA 119 1030/1 Uen A

© 1996 to 2009, Ericsson AB. All rights reserved.

Redback and SmartEdge are trademarks registered at the U.S. Patent & Trademark Office and in other countries. AOS, NetOp, SMS, and User Intelligent Networks are trademarks or service marks of Telefonaktiebolaget LM Ericsson. All other products or services mentioned are the trademarks, service marks, registered trademarks or registered service marks of their respective owners. All rights in copyright are reserved to the copyright owner. Company and product names are trademarks or registered trademarks of their respective owners. Neither the name of any third party software developer nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of such third party.

Rights and RestrictionsAll statements, specifications, recommendations, and technical information contained are current or planned as of the date of publication of this document. They are reliable as of the time of this writing and are presented without warranty of any kind, expressed or implied. In an effort to continuously improve the product and add features, Redback Networks Inc. (“Redback”) or Ericsson AB (“Ericsson”) and their affiliate companies reserve the right to change any specifications contained in this document without prior notice of any kind.

Neither Redback or Ericsson nor its parent or affiliate companies shall be liable for technical or editorial errors or omissions which may occur in this document. Neither Redback or Ericsson nor its affiliate companies shall be liable for any indirect, special, incidental or consequential damages resulting from the furnishing, performance, or use of this document.

DisclaimerNo part of this document may be reproduced in any form without the written permission of the copyright owner.

The contents of this document are subject to revision without notice due to continued progress in methodology, design and manufacturing. Redback or Ericsson shall have no liability for any error or damage of any kind resulting from the use of this document.

1

NetOp PM API Javadoc Introduction

The Javadoc supplied with the NetOp™ software, in both HTML and PDF format (/usr/local/npm/docs/API) defines the NetOp Policy Manager (PM) application programming interface (API). Although the Javadoc contains Java-specific syntax, you should refer to the Javadoc for the method names, parameter types, and all descriptions for use in developing a Simple Object Access Protocol (SOAP) client, regardless of the language in which the SOAP client is implemented; the NetOp PM API’s method names and parameter types do not vary by language. Use the Javadoc in conjunction with the web service definition language (WSDL) document included with the NetOp PM software when developing a SOAP client.

Method Names and Parameter Types

This section lists theNetOp PM API method names and parameter types, grouped by interface. You can add, update, or change one or more items using the Extensible Markup Language (XML) version of any API method name that starts with the prefix add, update, or change.

Table 1 lists the NetOp PM API method names and parameter types, grouped by interface.

Table 1 NetOp PM API Method Names and Parameter Types

Interface Method

AuthenticationIfc

authenticateSubscriber(String subAcctName, String subAcctPassword)

authenticateSubscriberSession(String ipAddr, String subAcctPassword)

authenticateSubscriberSessionWithReply(String ipAddr, String subAcctPassword)

authenticateSubscriberWithReply(String subAcctName, String subAcctPassword)

bindSubscriberToSession(String ipAddr, String subAcctName)

bindSubscriberToSessionAndApplyServices(String ipAddr, String subAcctName)

bindSubscriberToNASUser(String nasUser, String subAcctName)

bindSubscriberToNASUserAndApplyServices(String nasUser, String subAcctName)

logoffNASUserName(String nasUserName)

logoffSubSession(String ipAddr)


2 NetOp Policy Manager API Guide (Javadoc Version)

logoffSubSessions(String subAcctName)

logonNASUserName(String nasUserName, String subAcctName, String subAcctPassword)

logonNASUserNameWithReply(String nasUserName, String subAcctName, String subAcctPassword)

logonSubSession(String ipAddr, String subAcctName, String subAcctPassword)

logonSubSessionWithReply(String ipAddr, String subAcctName, String subAcctPassword)

nasUserNameIsLoggedOn(String nasUserName)

subAcctNameIsLoggedOn(String subAcctName)

subSessionIsLoggedOn(String ipAddr)

subSessionLogoff(String ipAddr, String subAcctPassword)

subSessionLogoffWithReply(String ipAddr, String subAcctPassword)

ConfigNASTypeIfc

addNASTypeXML(String nasTypeXML)

getAllNASTypesXML()

getNASTypeXML(String nasTypeName)

removeNASType(String nasTypeName)

updateNASTypeXML(String nasTypeXML)

ConfigRADIUSAttributeIfc

addRADIUSAttributeXML(String radiusAttributeXML)

getAllRADIUSAttributesXML()

getRADIUSAttributeXML(String radiusAttributeName)

removeRADIUSAttribute(String radiusAttributeName)

updateRADIUSAttributeXML(String radiusAttributeXML)

NASMgmtIfc

addNAS(NAS nas)

addNASXML(String NASXML)

getAllNAS()

getAllNASXML()

getNAS(String nasId)

getNASXML(String nasId)

removeNAS(String nasId)

updateNAS(NAS nas)

updateNASXML(String NASXML)

Table 1 NetOp PM API Method Names and Parameter Types (continued)

Interface Method


NetOp PM API Javadoc Introduction 3

ProxyMgmtIfc

addProxyInfo(ProxyInfo info)

getProxyInfo(String realm)

removeProxyInfo(String realm)

updateProxyInfo(ProxyInfo info)

RadiusAttributeGroupIfc

createRadAttrGroupXML(String radAttrGroupXML)

getAllRadAttrGroups( )

getAllRadAttrGroupsByType(String radAttrGrouptype)

getAllRadAttrGroupTypesXML( )

getRadAttrGroupDetailsXML(String id)

removeRadAttrGroup(String id)

updateRadAttrGroupXML(String radAttrGroupXML)

ServiceIfc

addServiceToSubAcctName(String subAcctName, String serviceId)

addServiceToSubAcctNameXML(String subAcctName, String serviceSubscriptionXML)

addServiceToSubSession(String ipAddr, String serviceId)

addServiceToSubSessionXML(String ipAddr, String serviceSubscriptionXML)

applyServicesToSubAcctName(String subAcctName)

applyServicesToSubSession(String ipAddr)

changeAndApplyServicesToSubAcctName(String subAcctName, String[] serviceIds)

changeAndApplyServicesToSubAcctNameXML(String subAcctName, String serviceSubscriptionsXML)

changeAndApplyServicesToSubSession(String ipAddr, String[] serviceIds)

changeAndApplyServicesToSubSessionXML(String ipAddr, String serviceSubscriptionsXML)

Deprecated changeAndApplyWholesaleServicesToSubAcctName(String subAcctName, String[] serviceIds)

Deprecated changeAndApplyWholesaleServicesToSubSession(String ipAddr, String[] serviceIds)

changeServicesForSubAcctNameXML(String subAcctName, String serviceSubscriptionsXML)

changeServicesForSubSessionXML(String ipAddr, String serviceSubscriptionsXML)

getAvailableServicesForSubSession(String ipAddr)

Deprecated getAvailableWholesaleServicesForSubSession(String ipAddr)

getMeteredTimeUsageForSubAcctName(String subAcctName)

getMeteredTimeUsageForSubSession(String ipAddr)

getMeteredVolumeUsageForSubAcctName(String subAcctName)


Interface Method



getMeteredVolumeUsageForSubSession(String ipAddr)

getSelectedServicesForSubAcctName(String subAcctName)

getSelectedServicesForSubSession(String ipAddr)

Deprecated getSelectedWholesaleServicesForSubAcctName(String subAcctName)

Deprecated getSelectedWholesaleServicesForSubSession(String ipAddr)

getServiceOrderHistory(String subAcctName)

getServiceSubscriptions(String subAcctName)

reactivateAndApplyServicesToSubAcctName(String subAcctName, String[] serviceIds)

reactivateAndApplyServicesToSubSession(String ipAddr, String[] serviceIds)

reactivateServicesForSubAcctName(String subAcctName, String[] serviceIds)

reactivateServicesForSubSession(String ipAddr, String[] serviceIds)

removeAllServices(String subAcctName)

removeAllServicesFromSubSession(String ipAddr)

Deprecated removeAllWholesaleServices(String subAcctName)

Deprecated removeAllWholesaleServicesFromSubSession(String ipAddr)

removeService(String subAcctName, String serviceId)

removeServiceFromSubSession(String ipAddr, String serviceId)

resetAllMeteredUsage( )

resetMeteredUsageForNAS(String nasId)

resetMeteredUsageForService(String serviceId)

resetMeteredUsageForSubAcctName(String subAcctName)

ServiceMgmtIfc

createServiceOfferingXML(String serviceXML)

getAllServiceOfferingTypesXML( )

getAllServices( )

getAllServicesByType(String svcOffrgType)

Deprecated getAllWholesaleServices( )

getAvailableRealmServices(String realm)

Deprecated getAvailableRealmWholesaleServices(String realm)

getAvailableServices( )

Deprecated getAvailableWholesaleServices( )

getServiceDetailsXML(String serviceId)

Deprecated getServiceDetailsXMLForRealm(String realm, String serviceId)

removeServiceOffering(String serviceId)


Interface Method


NetOp PM API Javadoc Introduction 5

updateServiceOfferingXML(String serviceXML)

SessionMgmtIfc

clearSubSessionByIPAddr(String ipAddr)

clearSubSessionByNASUserName(String nasUserName)

clearSubSessionBySubAcctName(String subAcctName)

getKnownNodeNames( )

getStaticIpAddresses(String subAcctName)

getSubscriberSession(String ipAddr)

getSubscriberSessionNames(String nasId, String filter)

getSubscriberSessions(String subAcctName)

getSubscriberSessionSummaries(String subAcctName)

getSubscriberSessionsByNAS(String nasId)

setStaticIpAddresses(String subAcctName, SessionIP[ ] ips)

UserMgmtIfc

addNASUser(NASUser nasUser)

addNASUserXML(String nasUserXML)

addSubscriberAccount(SubscriberAccount subAcct)

addSubscriberAccountXML(String subAcctXML)

getNASUser(String nasUserName)

getNASUsers(String subAcctName)

getNASUsersXML(String subAcctName)

getNASUserXML(String nasUserName)

getSubAcctName(String ipAddr)

getSubscriberAccount(String subAcctName)

getSubscriberAccountNameList(String filter, int numRows)

getSubscriberAccountNames(String filter)

getSubscriberAccountNamesByExternalId(String externalId)

getSubscriberAccountXML(String subAcctName)

removeNASUser(String nasUserName)

removeSubscriberAccount(String subAcctName)

setDefaultISPByNASUser(String nasUserName, String realm)

setDefaultISPBySubSession(String ipAddr, String realm)

updateNASUser(NASUser nasUser)

updateNASUserXML(String nasUserXML)


Interface Method



updateSubscriberAccount(SubscriberAccount subAcct)

updateSubscriberAccountXML(String subAcctXML)


Interface Method

Package

com.redback.npm.api.admin

Page 1


Interface ConfigAttributeTypeIfc

public interface ConfigAttributeTypeIfcextends java.rmi.Remote

ConfigAttributeTypeIfc is a web services endpoint that lets you add, delete, or update additional attributes.

Methods

addAttributeTypeXMLpublic void addAttributeTypeXML(java.lang.String AttributeXML) throws DuplicateDBColumnException, DuplicateAttributeException, InvalidLicenseException, InvalidNASTypeException, InvalidAttributeException, java.rmi.RemoteException, java.sql.SQLException

Adds additional Attributes to the NetOp PM database, and for each added Attribute adds the DBColumn of the Attributesto the accounting table and the radius_attributes table if the application type is 'Radius'.

Parameters:AttributeXML - the XML representation for these attributes being added to the NetOp PM database

Exceptions:DuplicateDBColumnException - if the specified DBColumn already exists in this accounting table or_attributes tableDuplicateAttributeException - if one or more of the Name/Vendor-id andAttributeNumber/DBColumn already exist in the databaseInvalidLicenseException - if the NAS type to be supported for this attribute is a third-party NAS type; ifthere is no license for the Third-party Vendor Support featureInvalidNASTypeException - if this NAS type is not a valid typeInvalidAttributeException - if the XML representation does not pass the validation; if theDBColumn specified in this XML representation is already in useRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

getAllAttributeTypesXMLpublic java.lang.String getAllAttributeTypesXML() throws java.rmi.RemoteException, java.sql.SQLException

Returns details of all additional Attributes from the NetOp PM database.

Returns:the XML representation for all attributes in the NetOp PM database

Exceptions:RemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:

(continued on next page)

Page 2

com.redback.npm.api.admin.ConfigAttributeTypeIfc

(continued from last page)

6.1.5

getAttributeTypeXMLpublic java.lang.String getAttributeTypeXML(java.lang.String applicationType, java.lang.String attributeTypeName) throws InvalidAttributeException, java.rmi.RemoteException, java.sql.SQLException

Returns details of the specified additional attribute from the NetOp PM database.

Parameters:applicationType - the type of application that this attribute is used for (Radius, Diameter, NPM, etc)attributeTypeName - the name of the attribute for which to return details

Returns:the XML representation for the attribute specified by the AttributeName

Exceptions:InvalidAttributeException - if the attribute with this specified name cannot be found in the systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

removeAttributeTypepublic void removeAttributeType(java.lang.String applicationType, java.lang.String attributeTypeName) throws InvalidAttributeException, AttributeInUseException, java.rmi.RemoteException, java.sql.SQLException

Removes an additional attribute from the NetOp PM database.

Parameters:applicationType - the type of application that this attribute is used for (Radius, Diameter, NPM)attributeTypeName - the name of this attribute to be removed from the NetOp PM database

Exceptions:InvalidAttributeException - if the attribute with the specified name cannot be found in the systemAttributeInUseException - if the attribute with the specified name is currently in useRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

updateAttributeTypeXMLpublic void updateAttributeTypeXML(java.lang.String attributeTypeXML) throws InvalidLicenseException, InvalidAttributeException, java.sql.SQLException, AttributeInUseException, java.rmi.RemoteException, UnmodifiableAttributeException

Modifies the details of the specified additional attributes in the NetOp PM database.

Page 3



Parameters:attributeTypeXML - the XML representation for these attributes being modified in the NetOp PM database

Exceptions:InvalidLicenseException - if the NAS type to be supported for this attribute is a third-party NAS type; ifthere is no license for the Third-party Vendor Support featureInvalidAttributeException - if the attribute with the specified name cannot be found in the systemAttributeInUseException - if the attribute with the specified name is currently in useRemoteException - if an unexpected error occursSQLException - if a database access error occursUnmodifiableAttributeException - if an attempt is made to modify this database or the restricted fieldsof a attribute definition

Since:6.1.5

Page 4



Interface ConfigDiameterPeerTypeIfc

public interface ConfigDiameterPeerTypeIfcextends java.rmi.Remote

ConfigDiameterPeerTypeIfc is a web services endpoint that enables you to add, retrieve, modify, and remove Diameter Peer typeinformation in the NetOp PM database.

Methods

addDiameterPeerTypeXMLpublic void addDiameterPeerTypeXML(java.lang.String diameterPeerTypeXML) throws DuplicateDiameterPeerTypeException, InvalidLicenseException, InvalidDiameterPeerTypeException, java.rmi.RemoteException, java.sql.SQLException

Adds a new Diameter Peer type to the NetOp PM database.

Parameters:diameterPeerTypeXML - the XML representation for Diameter Peer type being added to the NetOp PMdatabase.

Exceptions:DuplicateDiameterPeerTypeException - if this Diameter Peer Type already exists in the NetOp PMdatabaseInvalidLicenseException - if there is no license for the Credit Control featureInvalidDiameterPeerTypeException - if the XML representation does not pass the validationRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.4.4

getAllDiameterPeerTypesXMLpublic java.lang.String getAllDiameterPeerTypesXML() throws java.rmi.RemoteException, java.sql.SQLException

Returns details of all Diameter Peer types from the NetOp PM database.

Returns:the XML representations for all Diameter Peer types in the NetOp PM database


Since:6.1.4.4

Page 5

com.redback.npm.api.admin.ConfigDiameterPeerTypeIfc


getDiameterPeerTypeXMLpublic java.lang.String getDiameterPeerTypeXML(java.lang.String diameterPeerTypeName) throws InvalidDiameterPeerTypeException, java.rmi.RemoteException, java.sql.SQLException

Returns details of the specified Diameter Peer type from the NetOp PM database.

Parameters:diameterPeerTypeName - name of the Diameter Peer type for which to return details

Returns:the XML representation for the NAS type specified by the diameterPeerTypeName

Exceptions:InvalidDiameterPeerTypeException - if the XML representation does not pass the validation; if thespecified Credit Control Server type is not in the databaseRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.4.4

removeDiameterPeerTypepublic void removeDiameterPeerType(java.lang.String diameterPeerTypeName) throws InvalidDiameterPeerTypeException, DiameterPeerTypeInUseException, java.rmi.RemoteException, java.sql.SQLException

Removes a Diameter Peer type from the NetOp PM database.

Parameters:diameterPeerTypeName - name of the Diameter Peer type to be removed from the NetOp PM database

Exceptions:InvalidDiameterPeerTypeException - if the NAS type with the specified name cannot be found in thesystemDiameterPeerTypeInUseException - if the Diameter Peer type with the specified name is currently in useRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.4.4

updateDiameterPeerTypeXMLpublic void updateDiameterPeerTypeXML(java.lang.String diameterPeerTypeXML) throws InvalidLicenseException, InvalidDiameterPeerTypeException, DiameterPeerTypeInUseException, java.rmi.RemoteException, java.sql.SQLException

Modifies the details of the specified Diameter Peer type in the NetOp PM database.

Parameters:diameterPeerTypeXML - the XML representation for the Diameter Peer type being modified in the NetOp PMdatabase

Exceptions:InvalidLicenseException - if there is no license for the Third-party Vendor Support feature

Page 6



InvalidDiameterPeerTypeException - if the Diameter Peer type with the specified name cannot be foundin the systemDiameterPeerTypeInUseException - if the Diameter Peer type with the specified name is currently in useRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.4.4

Page 7



Interface ConfigDiameterRequestVariationTypeIfc

public interface ConfigDiameterRequestVariationTypeIfcextends java.rmi.Remote

ConfigDiameterRequestVariationTypeIfc is a web services endpoint that enables you to retrieve diameter request variation types inthe NetOp PM system.

Methods

getAllDiameterRequestVariationTypesXMLpublic java.lang.String getAllDiameterRequestVariationTypesXML() throwsjava.rmi.RemoteException, java.sql.SQLException

Returns details of all Diameter Request Variation Types from the NetOp PM database.

Returns:the XML representations for all Diameter Request Variation Types in the NetOp PM database


Since:6.1.5

getDiameterRequestVariationTypeXMLpublic java.lang.String getDiameterRequestVariationTypeXML(java.lang.StringdiameterRequestType) throwsInvalidDiameterRequestVariationTypeException, java.rmi.RemoteException, java.sql.SQLException

Returns details of the specified Diameter Request Variation Type from the NetOp PM database.

Parameters:diameterRequestType - the diameter request type

Returns:An XML document containing the Diameter Request Variation type

Exceptions:InvalidDiameterRequestVariationTypeException - if the specified diameter variation type cannotbe found in the system.RemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

Page 8

com.redback.npm.api.admin.ConfigDiameterRequestVariationTypeIfc


Interface ConfigNASTypeIfc

public interface ConfigNASTypeIfcextends java.rmi.Remote

ConfigNASTypeIfc is a web services endpoint that enables you to add, retrieve, modify, and remove NAS type information in theNetOp PM database.

Methods

addNASTypeXMLpublic void addNASTypeXML(java.lang.String nasTypeXML) throws DuplicateNASTypeException, InvalidLicenseException, InvalidNASTypeException, java.rmi.RemoteException, java.sql.SQLException

Adds a new NAS type to the NetOp PM database.

Parameters:nasTypeXML - the XML representation for NAS type being added to the NetOp PM database.

Exceptions:DuplicateNASTypeException - if this NASType already exists in the NetOp PM databaseInvalidLicenseException - if there is no license for the Third-party Vendor Support featureInvalidNASTypeException - if the XML representation does not pass the validationRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.0.3

getAllNASTypesXMLpublic java.lang.String getAllNASTypesXML() throws java.rmi.RemoteException, java.sql.SQLException

Returns details of all NAS types from the NetOp PM database.

Returns:the XML representations for all NAS types in the NetOp PM database


Since:6.0.3

Page 9

com.redback.npm.api.admin.ConfigNASTypeIfc


getNASTypeXMLpublic java.lang.String getNASTypeXML(java.lang.String nasTypeName) throws InvalidNASTypeException, java.rmi.RemoteException, java.sql.SQLException

Returns details of the specified NAS type from the NetOp PM database.

Parameters:nasTypeName - name of the NAS type for which to return details

Returns:the XML representation for the NAS type specified by the nasTypeName

Exceptions:InvalidNASTypeException - if the XML representation does not pass the validation; if the specified NAStype is not in the databaseRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.0.3

removeNASTypepublic void removeNASType(java.lang.String nasTypeName) throws InvalidNASTypeException, NASTypeInUseException, java.rmi.RemoteException, java.sql.SQLException

Removes a NAS type from the NetOp PM database.

Parameters:nasTypeName - name of the NAS type to be removed from the NetOp PM database

Exceptions:InvalidNASTypeException - if the NAS type with the specified name cannot be found in the systemNASTypeInUseException - if the NAS type with the specified name is currently in useRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.0.3

updateNASTypeXMLpublic void updateNASTypeXML(java.lang.String nasTypeXML) throws InvalidLicenseException, InvalidNASTypeException, NASTypeInUseException, java.rmi.RemoteException, java.sql.SQLException

Modifies the details of the specified NAS type in the NetOp PM database.

Parameters:nasTypeXML - the XML representation for the NAS type being modified in the NetOp PM database

Exceptions:InvalidLicenseException - if there is no license for the Third-party Vendor Support featureInvalidNASTypeException - if the NAS type with the specified name cannot be found in the system

Page 10



NASTypeInUseException - if the NAS type with the specified name is currently in useRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.0.3

Page 11



Interface ConfigRADIUSAttributeIfc

public interface ConfigRADIUSAttributeIfcextends java.rmi.Remote

ConfigRADIUSAttributeIfc is a web services endpoint that lets you add, delete, or update additional RADIUS attributes.

Methods

addRADIUSAttributeXMLpublic void addRADIUSAttributeXML(java.lang.String radiusAttributeXML) throws DuplicateDBColumnException, DuplicateRADIUSAttributeException, InvalidLicenseException, InvalidNASTypeException, InvalidRADIUSAttributeException, java.rmi.RemoteException, java.sql.SQLException

Adds additional RADIUS Attributes to the NetOp PM database, and for each added RADIUS Attribute adds theDBColumn of the RADIUS Attributes to the accounting table and the radius_attributes table.

Parameters:radiusAttributeXML - the XML representation for these RADIUS attributes being added to the NetOp PMdatabase

Exceptions:DuplicateDBColumnException - if the specified DBColumn already exists in this accounting table orradius_attributes tableDuplicateRADIUSAttributeException - if one or more of the Name/Vendor-id andAttributeNumber/DBColumn already exist in the databaseInvalidLicenseException - if the NAS type to be supported for this RADIUS attribute is a third-party NAStype; if there is no license for the Third-party Vendor Support featureInvalidNASTypeException - if this NAS type is not a valid typeInvalidRADIUSAttributeException - if the XML representation does not pass the validation; if theDBColumn specified in this XML representation is already in useRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:5.0.5

getAllRADIUSAttributesXMLpublic java.lang.String getAllRADIUSAttributesXML() throws java.rmi.RemoteException, java.sql.SQLException

Returns details of all additional RADIUS Attributes from the NetOp PM database.

Returns:the XML representation for all RADIUS attributes in the NetOp PM database


Page 12

com.redback.npm.api.admin.ConfigRADIUSAttributeIfc


Since:5.0.5

getRADIUSAttributeXMLpublic java.lang.String getRADIUSAttributeXML(java.lang.String radiusAttributeName) throws InvalidRADIUSAttributeException, java.rmi.RemoteException, java.sql.SQLException

Returns details of the specified additional RADIUS attribute from the NetOp PM database.

Parameters:radiusAttributeName - the name of the RADIUS attribute for which to return details

Returns:the XML representation for the RADIUS attribute specified by the radiusAttributeName

Exceptions:InvalidRADIUSAttributeException - if the RADIUS attribute with this specified name cannot be foundin the systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:5.0.5

removeRADIUSAttributepublic void removeRADIUSAttribute(java.lang.String radiusAttributeName) throws InvalidRADIUSAttributeException, RADIUSAttributeInUseException, java.rmi.RemoteException, java.sql.SQLException

Removes an additional RADIUS attribute from the NetOp PM database.

Parameters:radiusAttributeName - the name of this RADIUS attribute to be removed from the NetOp PM database

Exceptions:InvalidRADIUSAttributeException - if the RADIUS attribute with the specified name cannot be found inthe systemRADIUSAttributeInUseException - if the RADIUS attribute with the specified name is currently in useRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:5.0.5

updateRADIUSAttributeXMLpublic void updateRADIUSAttributeXML(java.lang.String radiusAttributeXML) throws InvalidLicenseException, InvalidNASTypeException, InvalidRADIUSAttributeException, java.sql.SQLException, RADIUSAttributeInUseException, java.rmi.RemoteException, UnmodifiableRADIUSAttributeException

Modifies the details of the specified additional RADIUS attributes in the NetOp PM database.

Page 13



Parameters:radiusAttributeXML - the XML representation for these RADIUS attributes being modified in the NetOp PMdatabase

Exceptions:InvalidLicenseException - if the NAS type to be supported for this RADIUS attribute is a third-party NAStype; if there is no license for the Third-party Vendor Support featureInvalidNASTypeException - if this NAS type is not a valid type.InvalidRADIUSAttributeException - if the RADIUS attribute with the specified name cannot be found inthe systemRADIUSAttributeInUseException - if the RADIUS attribute with the specified name is currently in useRemoteException - if an unexpected error occursSQLException - if a database access error occursUnmodifiableRADIUSAttributeException - if an attempt is made to modify this database or therestricted fields of a RADIUS attribute definition

Since:5.0.5

Page 14



Interface DiameterPeerMgmtIfc

public interface DiameterPeerMgmtIfcextends java.rmi.Remote

DiameterPeerMgmtIfc is a web services endpoint that enables you to add, retrieve, modify, and remove Diameter Peerconfiguration information in the NetOp PM database.

Methods

addDiameterPeerXMLpublic void addDiameterPeerXML(java.lang.String diameterPeersXML) throws DuplicateDiameterPeerException, InvalidLicenseException, InvalidDiameterPeerException, java.rmi.RemoteException, java.sql.SQLException

Adds a new Diameter Peer to the NetOp PM database.

Parameters:diameterPeersXML - the XML representation for Diameter Peer being added to the NetOp PM database.

Exceptions:DuplicateDiameterPeerException - if this Diameter Peer already exists in the NetOp PM databaseInvalidLicenseException - if there is no license for the Credit Control featureInvalidDiameterPeerException - if the XML representation does not pass the validationjava.rmi.RemoteException - if an unexpected error occursjava.sql.SQLException - if a database access error occurs

Since:6.1.5

getAllDiameterPeersXMLpublic java.lang.String getAllDiameterPeersXML() throws java.rmi.RemoteException, java.sql.SQLException

Returns details of all Diameter Peer from the NetOp PM database.

Returns:the XML representations for all Diameter Peer in the NetOp PM database


Since:6.1.5

Page 15

com.redback.npm.api.admin.DiameterPeerMgmtIfc


getDiameterPeerXMLpublic java.lang.String getDiameterPeerXML(java.lang.String diameterPeerName) throws InvalidDiameterPeerException, java.rmi.RemoteException, java.sql.SQLException

Returns details of the specified Diameter Peer from the NetOp PM database.

Parameters:diameterPeerName - name of the Diameter Peer for which to return details

Returns:the XML representation for the Diameter Peer specified by the diameterPeerName

Exceptions:InvalidDiameterPeerException - if the XML representation does not pass the validation; if the specifiedCredit Control Server is not in the databaseRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

removeDiameterPeerpublic void removeDiameterPeer(java.lang.String diameterPeerName) throws InvalidDiameterPeerException, DiameterPeerInUseException, java.rmi.RemoteException, java.sql.SQLException

Removes a Diameter Peer from the NetOp PM database.

Parameters:diameterPeerName - name of the Diameter Peer to be removed from the NetOp PM database

Exceptions:InvalidDiameterPeerException - if the Diameter Peer with the specified name cannot be found in thesystemDiameterPeerInUseException - if the Diameter Peer with the specified name is currently in useRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

updateDiameterPeerXMLpublic void updateDiameterPeerXML(java.lang.String diameterPeersXML) throws DiameterPeerInUseException, InvalidLicenseException, InvalidDiameterPeerException, java.rmi.RemoteException, java.sql.SQLException

Modifies the details of the specified Diameter Peer in the NetOp PM database.

Parameters:diameterPeersXML - the XML representation for the Diameter Peer being modified in the NetOp PM database

Exceptions:InvalidLicenseException - if there is no license for the Third-party Vendor Support feature

Page 16



InvalidDiameterPeerException - if the Diameter Peer with the specified name cannot be found in thesystemDiameterPeerInUseException - if the Diameter Peer with the specified name is currently in useRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

Page 17



Interface DiameterRequestVariationMgmtIfc

public interface DiameterRequestVariationMgmtIfcextends java.rmi.Remote

DiameterRequestVariationMgmtIfc is a web services endpoint that enables you to retrieve diameter request variations in the NetOpPM system.

Methods

addDiameterRequestVariationXMLpublic void addDiameterRequestVariationXML(java.lang.StringdiameterRequestVariationXML) throws DuplicateDiameterRequestVariationException, InvalidDiameterRequestVariationException, InvalidLicenseException, java.rmi.RemoteException, java.sql.SQLException

Adds a new Diameter Request Variation to the NetOp PM database. The details of the Diameter Request Variation arecontained in an XML document.

Parameters:diameterRequestVariationXML - the XML representation for the new Diameter Request Variation

Exceptions:InvalidLicenseException - if not licensed for Diameter FunctionDuplicateDiameterRequestVariationException - if this diameter request variation already exists inthe NetOp PM databaseInvalidDiameterRequestVariationException - if the XML representation does not pass the validationRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

updateDiameterRequestVariationXMLpublic void updateDiameterRequestVariationXML(java.lang.StringdiameterRequestVariationXML) throwsInvalidDiameterRequestVariationException, InvalidLicenseException, java.rmi.RemoteException, DiameterRequestVariationInUseException, java.sql.SQLException

Updates an existing Diameter Request Variation to the NetOp PM database. The details of the Diameter Request Variationare contained in an XML document.

Parameters:diameterRequestVariationXML - the XML representation for the Credit Control Request Variation

Exceptions:InvalidLicenseException - if not licensed for Diameter FunctionInvalidDiameterRequestVariationException - if the diameter request variation with the specifiedname cannot be found in the system

Page 18

com.redback.npm.api.admin.DiameterRequestVariationMgmtIfc


RemoteException - if an unexpected error occursDiameterRequestVariationInUseException - if the diameter request variation with the specified nameis currently in useSQLException - if a database access error occurs

Since:6.1.5

removeDiameterRequestVariationpublic void removeDiameterRequestVariation(java.lang.StringdiameterRequestVariationName) throws DiameterRequestVariationInUseException, InvalidDiameterRequestVariationException, java.rmi.RemoteException, java.sql.SQLException

Deletes an existing Diameter Request Variation to the NetOp PM database.

Parameters:diameterRequestVariationName - the name for the Diameter Request Variation

Exceptions:DiameterRequestVariationInUseException - if the diameter request variation with the specified nameis currently in useInvalidDiameterRequestVariationException - if the diameter request variation with the specifiedname cannot be found in the systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

getAllDiameterRequestVariationsXMLpublic java.lang.String getAllDiameterRequestVariationsXML() throws java.rmi.RemoteException, java.sql.SQLException

Get all existing Diameter Request Variations from the NetOp PM database. The details of the Diameter Request Variationare contained in an XML document.

Returns:the XML representation of the Diameter Request Variation


Since:6.1.5

getDiameterRequestVariationXMLpublic java.lang.String getDiameterRequestVariationXML(java.lang.StringdiameterRequestVariationName) throwsInvalidDiameterRequestVariationException, java.rmi.RemoteException, java.sql.SQLException

Get an existing Diameter Request Variation to the NetOp PM database. The details of the Diameter Request Variation arecontained in an XML document.

Page 19



Parameters:diameterRequestVariationName - the name for the Diameter Request Variation


Exceptions:InvalidDiameterRequestVariationException - if the diameter request variations with the specifiedtype cannot be found in the systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

getDiameterRequestVariationsByTypeXMLpublic java.lang.String getDiameterRequestVariationsByTypeXML(java.lang.StringdiameterRequestVariationType) throwsInvalidDiameterRequestVariationException, java.rmi.RemoteException, java.sql.SQLException

Get an existing Diameter Request Variation by type from the NetOp PM database. The details of the Diameter RequestVariation are contained in an XML document.

Parameters:diameterRequestVariationType - the name for the Diameter Request Variation


Exceptions:InvalidDiameterRequestVariationException - if the diameter request variation with the specifiedtype cannot be found in the systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

Page 20



Class LdapProxyServer

java.lang.Object | +-com.redback.npm.api.admin.ProxyServer | +-com.redback.npm.api.admin.LdapProxyServer

public class LdapProxyServerextends ProxyServer

This class represents a single LDAP server to which NPM can proxy an authentication request.

Constructors

LdapProxyServerpublic LdapProxyServer()

Default constructor

Methods

getBaseDNpublic java.lang.String getBaseDN()

Get the base DN for searches

Returns:the base DN for searches

setBaseDNpublic void setBaseDN(java.lang.String baseDN)

Set the base DN for searches

Parameters:baseDN - the base DN for searches

getNameAttributepublic java.lang.String getNameAttribute()

Get the username attribute

Returns:the username attribute

setNameAttributepublic void setNameAttribute(java.lang.String nameAttr)

Set the username attribute

Parameters:

Page 21

com.redback.npm.api.admin.LdapProxyServer


nameAttr - the username attribute

Page 22

com.redback.npm.api.admin.LdapProxyServer


Class NAS

java.lang.Object | +-com.redback.npm.api.admin.NAS

public class NASextends java.lang.Object

This class provides a SOAP representation of the NASInfo class.

Constructors

NASpublic NAS()

Methods

getDefaultRealmpublic java.lang.String getDefaultRealm()

Returns the default realm of this NAS.

Returns:the default realm of this NAS

setDefaultRealmpublic void setDefaultRealm(java.lang.String defaultRealm)

Sets the default realm of this NAS.

Parameters:defaultRealm - the new default realm for this NAS

getIdpublic java.lang.String getId()

Returns the identifier for this NAS.

Returns:the identifier for this NAS

setIdpublic void setId(java.lang.String id)

Sets the identifier for this NAS.

Parameters:id - the identifier for this NAS

Page 23

com.redback.npm.api.admin.NAS

getIPAddresspublic java.lang.String getIPAddress()

Returns the ip address for this NAS.

Returns:the ip address for this NAS

setIPAddresspublic void setIPAddress(java.lang.String ipAddress)

Sets the ip address for this NAS.

Parameters:ipAddress - the new ip address for this NAS

getSecretpublic java.lang.String getSecret()

Returns the shared secret for this NAS.

Returns:the shared secret for this NAS

setSecretpublic void setSecret(java.lang.String secret)

Sets the shared secret for this NAS.

Parameters:secret - the new shared secret for this NAS

getSoftwareVersionpublic java.lang.String getSoftwareVersion()

Returns the software version for this NAS.

Returns:the software version for this NAS

setSoftwareVersionpublic void setSoftwareVersion(java.lang.String softwareVersion)

Sets the software version for this NAS.

Parameters:softwareVersion - the new software version for this NAS

getSNMPCommunitypublic java.lang.String getSNMPCommunity()

Returns the SNMP community for this NAS.

Returns:

Page 24



the SNMP community for this NAS

setSNMPCommunitypublic void setSNMPCommunity(java.lang.String SNMPCommunity)

Sets the SNMP community for this NAS.

Parameters:SNMPCommunity - the new SNMP community for this NAS

getTypepublic java.lang.String getType()

Returns the type for this NAS.

Returns:the type for this NAS

setTypepublic void setType(java.lang.String type)

Sets the type for this NAS.

Parameters:type - the new type for this NAS

getCoAPortpublic java.lang.Integer getCoAPort()

Returns the CoAPort of this NAS

Returns:the CoAPort this NAS is listening on

setCoAPortpublic void setCoAPort(java.lang.Integer port)

Sets the CoA port of this NAS

Parameters:port - the CoAPort his NAS is listening on

getCoASecretpublic java.lang.String getCoASecret()

Returns the CoASecret of this NAS

Returns:the CoASecret of this NAS

setCoASecretpublic void setCoASecret(java.lang.String secret)

Set the CoASecret used by this NAS

Page 25



Parameters:secret - the secret used to generate CoA authenticators

Page 26



Interface NASMgmtIfc

public interface NASMgmtIfcextends java.rmi.Remote

NASMgmtIfc is a web services endpoint that enables you to add, retrieve, modify, and remove NAS configuration information inthe NetOp PM database.

Methods

addNASpublic void addNAS(NAS nas) throws DuplicateNASException, InvalidLicenseException, InvalidNASException, java.rmi.RemoteException, java.sql.SQLException

Adds a NAS configuration to the NetOp PM database.

Parameters:nas - a NAS object that contains the configuration information being added

Exceptions:DuplicateNASException - if the specified NAS already existsInvalidLicenseException - if the NAS type of this NAS is a third-party NAS type, and there is no validlicense for the Third-party Vendor Support featureInvalidNASException - if the specified NAS is not validRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.0.3

addNASXMLpublic void addNASXML(java.lang.String NASXML) throws DuplicateNASException, InvalidLicenseException, InvalidNASException, java.rmi.RemoteException, java.sql.SQLException

Adds one or more NAS configurations to the NetOp PM database.

Parameters:NASXML - the XML representation for this NAS configuration being added

Exceptions:DuplicateNASException - if the specified NAS already existsInvalidLicenseException - if the NAS type for this NAS is a third-party NAS type, and there is no validlicense for the Third-party Vendor Support featureInvalidNASException - if the specified NASXML is not validRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Page 27

com.redback.npm.api.admin.NASMgmtIfc


Since:6.0.3

getAllNASpublic NAS[] getAllNAS() throws java.rmi.RemoteException, java.sql.SQLException

Returns all NAS configurations from the NetOp PM database.

Returns:an array of NAS objects that contains details of the NAS configurations


Since:6.0.3

getAllNASXMLpublic java.lang.String getAllNASXML() throws java.rmi.RemoteException, java.sql.SQLException

Returns all XML representations for all NAS configurations from the NetOp PM database.

Returns:an XML representation for all NAS configurations


Since:6.0.3

getNASpublic NAS getNAS(java.lang.String nasId) throws InvalidNASException, java.rmi.RemoteException, java.sql.SQLException

Returns the NAS configuration from the NetOp PM database.

Parameters:nasId - the NAS identifier

Returns:a NAS object that contains the details of this NAS configuration associated with the specified nasId

Exceptions:InvalidNASException - if the specified nasId does not existRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.0.3

Page 28


getNASXMLpublic java.lang.String getNASXML(java.lang.String nasId) throws InvalidNASException, java.rmi.RemoteException, java.sql.SQLException

Returns the XML representation of the NAS configuration from the NetOp PM database.


Returns:an XML representation for this NAS configuration specified by nasId

Exceptions:InvalidNASException - if the specified nasId does not existRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.0.3

removeNASpublic void removeNAS(java.lang.String nasId) throws InvalidNASException, NASInUseException, java.rmi.RemoteException, java.sql.SQLException

Removes the NAS configuration from the NetOp PM database based on the specified NAS identifier.


Exceptions:InvalidNASException - if the specified nasId does not existNASInUseException - if the specified nasId is still being referencedRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.0.3

updateNASpublic void updateNAS(NAS nas) throws InvalidLicenseException, InvalidNASException, java.rmi.RemoteException, java.sql.SQLException

Updates the NAS configuration in the NetOp PM database.

Parameters:nas - a NAS object that contains the configuration information being updated

Exceptions:InvalidLicenseException - if the NAS type of this NAS is a third-party NAS type; if there is no validlicense for the Third-party Vendor Support featureInvalidNASException - if the specified NAS does not exist

Page 29



RemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.0.3

updateNASXMLpublic void updateNASXML(java.lang.String NASXML) throws InvalidLicenseException, InvalidNASException, java.rmi.RemoteException, java.sql.SQLException

Updates the NAS configuration in the NetOp PM database.

Parameters:NASXML - the XML representation for the NAS configuration being updated

Exceptions:InvalidLicenseException - if the NAS type of this NAS is a third-party NAS type; if there is no validlicense for the Third-party Vendor Support featureInvalidNASException - if the specified NAS does not existRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.0.3

Page 30



Class ProxyInfo

java.lang.Object | +-com.redback.npm.api.admin.ProxyInfo

public class ProxyInfoextends java.lang.Object

Objects of this class encapsulate the NetOp PM proxy configuration for a realm.

Constructors

ProxyInfopublic ProxyInfo()

Default constructor

Methods

getRealmpublic java.lang.String getRealm()

Returns the realm associated with this proxy configuration information.

Returns:the realm associated with this proxy configuration

setRealmpublic void setRealm(java.lang.String realm)

Sets the realm associated with this proxy configuration information.

Parameters:realm - the realm to associate with this proxy configuration

getProxyTypepublic java.lang.String getProxyType()

Returns the type of the proxy used for proxied authentications.

Returns:the type of proxy used for proxied authentications, either RADIUS or LDAP

setProxyTypepublic void setProxyType(java.lang.String type)

Sets the type of proxy used for proxied authentications.

Parameters:type - the type of proxy used for proxied authentications, either RADIUS or LDAP

Page 31

com.redback.npm.api.admin.ProxyInfo

getAlgorithmpublic java.lang.String getAlgorithm()

Returns the algorithm that the NetOp PM API server and the NetOp PM RADIUS servers use for distributing RADIUS orLDAP messages to external RADIUS servers or external LDAP servers.

Returns:the algorithm used, either first or round robin

setAlgorithmpublic void setAlgorithm(java.lang.String algorithm)

Sets the algorithm that the NetOp PM API server and the NetOp PM RADIUS servers use for distributing RADIUS orLDAP messages to external RADIUS servers or external LDAP servers.

Parameters:algorithm - the algorithm to use, either first or round robin

isProxyLoginAccessRequestpublic boolean isProxyLoginAccessRequest()

Returns if this realm is configured to proxy login access requests.

Returns:true if login access requests are proxied, otherwise false

setProxyLoginAccessRequestpublic void setProxyLoginAccessRequest(boolean proxy)

Sets this realm's configuration for proxying login access requests.

Parameters:proxy - whether login access requests are to be proxied

isProxyServiceChangeAccessRequestpublic boolean isProxyServiceChangeAccessRequest()

Return if this realm is configured to proxy service change access requests.

Returns:true if service change access requests are proxied, otherwise false

setProxyServiceChangeAccessRequestpublic void setProxyServiceChangeAccessRequest(boolean proxy)

Sets this realm's configuration for proxying service change access requests.

Parameters:proxy - whether service change access requests are to be proxied

isProxyAcctStartpublic boolean isProxyAcctStart()

Determines whether this realm is configured to proxy Accounting-Start records.

Page 32



Returns:true if Accounting-Start records are proxied, otherwise false

setProxyAcctStartpublic void setProxyAcctStart(boolean proxy)

Informs the system whether to proxy Accounting-Start records for this realm.

Parameters:proxy - whether Accounting-Start records are to be proxied

isProxyAcctStoppublic boolean isProxyAcctStop()

Determines whether this realm is configured to proxy Accounting-Stop records.

Returns:true if Accounting-Stop records are proxied, otherwise false

setProxyAcctStoppublic void setProxyAcctStop(boolean proxy)

Informs the system whether to proxy Accounting-Stop records for this realm.

Parameters:proxy - whether Accounting-Stop records are to be proxied

isProxyAcctOnpublic boolean isProxyAcctOn()

Determines whether this realm is configured to proxy Accounting-On records.

Returns:true if Accounting-On records are proxied, otherwise false

setProxyAcctOnpublic void setProxyAcctOn(boolean proxy)

Informs the system whether to proxy Accounting-On records for this realm.

Parameters:proxy - whether Accounting-On records are to be proxied

isProxyAcctOffpublic boolean isProxyAcctOff()

Determines whether this realm is configured to proxy Accounting-Off records.

Returns:true if Accounting-Off records are proxied, otherwise false

setProxyAcctOffpublic void setProxyAcctOff(boolean proxy)

Informs the system whether to proxy Accounting-Off records for this realm.

Page 33



Parameters:proxy - whether Accounting-Off records are to be proxied

isProxyAcctAlivepublic boolean isProxyAcctAlive()

Determines whether this realm is configured to proxy Accounting-Alive records.

Returns:true if Accounting-Alive records are proxied, otherwise false

setProxyAcctAlivepublic void setProxyAcctAlive(boolean proxy)

Informs the system whether to proxy Accounting-Alive records for this realm.

Parameters:proxy - whether Accounting-Alive records are to be proxied

isStoreAcctStartpublic boolean isStoreAcctStart()

Determines whether this realm is configured to store Accounting-Start records.

Returns:true if Accounting-Start records are stored, otherwise false

setStoreAcctStartpublic void setStoreAcctStart(boolean store)

Informs the system whether to store Accounting-Start records for this realm.

Parameters:store - whether Accounting-Start records are to be stored

isStoreAcctStoppublic boolean isStoreAcctStop()

Determines whether this realm is configured to store Accounting-Stop records.

Returns:true if Accounting-Stop records are stored, otherwise false

setStoreAcctStoppublic void setStoreAcctStop(boolean store)

Informs the system whether to store Accounting-Stop records for this realm.

Parameters:store - whether Accounting-Stop records are to be stored

isStoreAcctOnpublic boolean isStoreAcctOn()

Page 34



Determines whether this realm is configured to store Accounting-On records.

Returns:true if Accounting-On records are stored, otherwise false

setStoreAcctOnpublic void setStoreAcctOn(boolean store)

Informs the system whether to store Accounting-On records for this realm.

Parameters:store - whether Accounting-On records are to be stored

isStoreAcctOffpublic boolean isStoreAcctOff()

Determines whether this realm is configured to store Accounting-Off records.

Returns:true if Accounting-Off records are stored, otherwise false

setStoreAcctOffpublic void setStoreAcctOff(boolean store)

Informs the system whether to store Accounting-Off records for this realm.

Parameters:store - whether Accounting-Off records are to be stored

isStoreAcctAlivepublic boolean isStoreAcctAlive()

Determines whether this realm is configured to store Accounting-Alive records.

Returns:true if Accounting-Alive records are stored, otherwise false

setStoreAcctAlivepublic void setStoreAcctAlive(boolean store)

Informs the system whether to store Accounting-Alive records for this realm.

Parameters:store - whether Accounting-Alive records are to be stored

isDeleteOnAcctOffpublic boolean isDeleteOnAcctOff()

Determines whether this realm is configured to delete nas_session entries when an Accounting-Off record is received fromthe NAS.

Returns:true if nas_session entries are to be removed when an Accounting-Off is received from the NAS, otherwise false

Page 35



setDeleteOnAcctOffpublic void setDeleteOnAcctOff(boolean del)

Informs the system whether this realm is configured to delete nas_session entries when an Accounting-Off record isreceived from the NAS.

Parameters:del - whether nas_session entries are to be removed when Accounting-Off record is received

getDefaultWebLogonServicepublic java.lang.String getDefaultWebLogonService()

Returns the configured default web logon service. The default web logon service is used, if the subscriber is not logged on,to force the subscriber to the web portal logon page.

Returns:the default web logon service identifier

setDefaultWebLogonServicepublic void setDefaultWebLogonService(java.lang.String webServ)

Sets the realm's default web logon service.

Parameters:webServ - the service identifier of the default web logon service

getDefaultServicepublic java.lang.String getDefaultService()

Returns the default service identifier. The default service offering is used if the subscriber has no services configured in theNetOp PM database.

Returns:the default service identifier

setDefaultServicepublic void setDefaultService(java.lang.String serv)

Sets the realm's default service.

Parameters:serv - the service identifier of the default service for this realm

getInvalidLoginRedirectServicepublic java.lang.String getInvalidLoginRedirectService()

Returns the invalid login redirect service identifier. The invalid login redirect service is used to redirect PPPoA or PPPoEsubscribers who attempt to log on with an invalid username or incorrect password.

Returns:the invalid login service identifier

setInvalidLoginRedirectServicepublic void setInvalidLoginRedirectService(java.lang.String serv)

Sets the realm's invalid login redirect service identifier.

Page 36



Parameters:serv - the invalid login redirect service identifier

isDoubleAccessSuppressionpublic boolean isDoubleAccessSuppression()

Determines whether the NetOp PM system is configured to suppress the proxy of two RADIUS Access-Request packetsfrom the NetOp PM RADIUS server to the external RADIUS server when a subscriber logs on through the web portal.

Returns:true if double Access-Request packets are suppressed, otherwise false

setDoubleAccessSuppressionpublic void setDoubleAccessSuppression(boolean suppress)

Informs the system whether to suppress the proxy of two RADIUS Access-Request packets for this realm when asubscriber logs on through the web portal.

Parameters:suppress - whether double Access-Request packets are to be suppressed

getInvalidLocationRedirectServicepublic java.lang.String getInvalidLocationRedirectService()

Returns the invalid location redirect service identifier. The invalid location redirect service is used to redirect PPPoA orPPPoE subscribers who attempt to log on from an invalid location.

Returns:the invalid location service identifier

setInvalidLocationRedirectServicepublic void setInvalidLocationRedirectService(java.lang.String serv)

Sets the realm's invalid location redirect service identifier.

Parameters:serv - the invalid location redirect service identifier

getInactiveAccountRedirectServicepublic java.lang.String getInactiveAccountRedirectService()

Returns the inactive account redirect service identifier. The inactive account redirect service is used to redirect PPPoA orPPPoE subscribers who attempt to log on when the subscriber account is inactive.

Returns:the inactive account redirect service identifier

setInactiveAccountRedirectServicepublic void setInactiveAccountRedirectService(java.lang.String serv)

Sets the realm's inactive account redirect service identifier.

Parameters:serv - the inactive account redirect service identifier

Page 37


getRadiusProxyServerspublic RadiusProxyServer[] getRadiusProxyServers()

Returns a list of RADIUS proxy servers for this realm.

Returns:an array of RadiusProxyServer objects that contain the RADIUS proxy servers for this realm

setRadiusProxyServerspublic void setRadiusProxyServers(RadiusProxyServer[] servers)

Sets the list of RADIUS proxy servers for this realm.

Parameters:servers - an array of RadiusProxyServer objects that contain the RADIUS proxy servers for this realm

getLdapProxyServerspublic LdapProxyServer[] getLdapProxyServers()

Returns a list of external LDAP servers that the NetOp PM system queries for this realm.

Returns:an array of LdapProxyServer objects that contain the external LDAP servers for this realm

setLdapProxyServerspublic void setLdapProxyServers(LdapProxyServer[] servers)

Sets the list of external LDAP servers that the NetOp PM system queries for this realm.

Parameters:servers - an array of LdapProxyServer objects that contain the external LDAP servers for this realm

Page 38



Interface ProxyMgmtIfc

public interface ProxyMgmtIfcextends java.rmi.Remote

ProxyMgmtIfc is a web services endpoint that enables you to add, retrieve, modify, and remove proxy configuration information inthe NetOp PM database.

Methods

addProxyInfopublic void addProxyInfo(ProxyInfo info) throws DuplicateProxyInfoException, InvalidLdapProxyServerException, InvalidLicenseException, InvalidProxyInfoException, InvalidRadiusProxyServerException, InvalidServiceException, NoAccessServiceException, java.rmi.RemoteException, java.sql.SQLException

Adds the specified proxy configuration to the NetOp PM database.

Parameters:info - a ProxyInfoobject that contains the configuration information to be added.

Exceptions:DuplicateProxyInfoException - if a configuration already exists for the specified realmInvalidLdapProxyServerException - if any of the LdapProxyServerobjects specified is not validInvalidLicenseException - if a required license is missingInvalidProxyInfoException - if the ProxyInfoobject specified is not validInvalidRadiusProxyServerException - if any of the RadiusProxyServerobjects specified is not validInvalidServiceException - if an unknown service identifier is specified in the ProxyInfoobjectNoAccessServiceException - if default/invalid redirect services is not an Access service or if the invalidredirect services does not have the DynamicIPAddress variation definedRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

getProxyInfopublic ProxyInfo getProxyInfo(java.lang.String realm) throws InvalidProxyInfoException, java.rmi.RemoteException, java.sql.SQLException

Returns the proxy setup for the specified realm. If the specified realm does not have an explicit configuration, the defaultconfiguration is returned.

Parameters:realm - the realm for which proxy configuration information is being retrieved

Returns:

Page 39

com.redback.npm.api.admin.ProxyMgmtIfc


a ProxyInfoobject that contains the configuration information for the specified realm

Exceptions:InvalidProxyInfoException - if no entry exists for the specified realm and the default realm does not existRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

removeProxyInfopublic void removeProxyInfo(java.lang.String realm) throws InvalidProxyInfoException, java.rmi.RemoteException, java.sql.SQLException

Removes the proxy configuration from the NetOp PM database for the specified realm.

Parameters:realm - the realm from which to remove the configuration information

Exceptions:InvalidProxyInfoException - if the proxy configuration information for the specified realm does not existRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

updateProxyInfopublic void updateProxyInfo(ProxyInfo info) throws InvalidLdapProxyServerException, InvalidLicenseException, InvalidProxyInfoException, InvalidRadiusProxyServerException, InvalidServiceException, NoAccessServiceException, java.rmi.RemoteException, java.sql.SQLException

Updates the proxy configuration for the specified realm.

Parameters:info - a ProxyInfoobject that contains the configuration information used to update the realm

Exceptions:InvalidLdapProxyServerException - if any of the LdapProxyServerobjects specified is not validInvalidLicenseException - if a required license is missingInvalidProxyInfoException - if the ProxyInfoobject specified is not validInvalidRadiusProxyServerException - if any of the RadiusProxyServerobjects specified is not validInvalidServiceException - if an unknown service identifier is specified in the ProxyInfoobjectNoAccessServiceException - if default/invalid redirect services is not an Access service or if the invalidredirect services does not have the DynamicIPAddress variation definedRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

Page 40

com.redback.npm.api.admin.ProxyMgmtIfc


Class ProxyServer

java.lang.Object | +-com.redback.npm.api.admin.ProxyServer

public abstract class ProxyServerextends java.lang.Objectimplements java.lang.Comparable

This class represents a single server to which NPM can proxy an authentication request.

All Implemented interfaces:java.lang.Comparable

Direct Known Subclasses:RadiusProxyServer, LdapProxyServer

Methods

setHostpublic void setHost(java.lang.String host)

Set hostname or IP address of the Proxy server

Parameters:host - the hostname or IP address of the proxy server

getHostpublic java.lang.String getHost()

Get the hostname or IP address of the Proxy server

Returns:the hostname or IP Address of the proxy server

setPortpublic void setPort(int port)

Set the authentication port of the Proxy server

Parameters:port - the authentication port number of the proxy server

getPortpublic int getPort()

Get the authentication port of the Proxy server

Returns:the authentication port number of the proxy server

Page 41

com.redback.npm.api.admin.ProxyServer

setRetryLimitpublic void setRetryLimit(int retries)

Set the number of retransmission attempt to the Proxy server

Parameters:retries - the number of retransmission attempt

getRetryLimitpublic int getRetryLimit()

Get the number of retransmission attempt to the Proxy server

Returns:the number of retransmission attempt

setSequencepublic void setSequence(int sequence)

Set the sequence number for this server in this realm

Parameters:sequence - the sequence number of this server in this realm

getSequencepublic int getSequence()

Get the sequence number for this server in this realm

Returns:the sequence number of this server in this realm

setTimeoutpublic void setTimeout(int timeout)

Set the number of seconds to wait for response from this proxy server

Parameters:timeout - the number of seconds to wait for response from this proxy server

getTimeoutpublic int getTimeout()

Get the number of seconds to wait for response from this proxy server

Returns:the number of seconds to wait for response from this proxy server

compareTopublic int compareTo(java.lang.Object o)

Note: this class has a natural ordering that is inconsistent with equals. This function is used for sorting the ProxyServerobject in sequential order.

Parameters:

Page 42



o

Returns:-1 if the specified object's sequence number is greater than this ProxyServer's sequence number 0 if the specifiedobject's sequence number is the same as this ProxyServer's sequence number 1 if the specified object's sequencenumber is less than this ProxyServer's sequence number or the specified object is null

Page 43



Class RadiusProxyServer

java.lang.Object | +-com.redback.npm.api.admin.ProxyServer | +-com.redback.npm.api.admin.RadiusProxyServer

public class RadiusProxyServerextends ProxyServer

This class represents a single radius server to which NPM can proxy an authentication request.

Constructors

RadiusProxyServerpublic RadiusProxyServer()

Default constructor

Methods

getSecretpublic java.lang.String getSecret()

Get the secret key

Returns:the secret key

setSecretpublic void setSecret(java.lang.String secret)

Set the secret key

Parameters:secret - the secret key

getAcctPortpublic int getAcctPort()

Get the accounting port number of the radius proxy server

Returns:the accounting port number of the radius proxy server

setAcctPortpublic void setAcctPort(int acctPort)

Set the accounting port number of the radius proxy server

Parameters:

Page 44

com.redback.npm.api.admin.RadiusProxyServer


acctPort - the accounting port number of the radius proxy server

Page 45

com.redback.npm.api.admin.RadiusProxyServer

Package

com.redback.npm.api.auth

Page 46

com.redback.npm.api.auth

Interface AuthenticationIfc

public interface AuthenticationIfcextends java.rmi.Remote

AuthenticationIfc is a web services endpoint that enables you to authenticate, log on, and log off subscribers.

Methods

authenticateSubscriberpublic boolean authenticateSubscriber(java.lang.String subAcctName, java.lang.String subAcctPassword) throws java.rmi.RemoteException, java.sql.SQLException, VerifyException

Verifies that the specified subscriber account name and password exist in the NetOp PM database, or in an externalRADIUS server if the NetOp PM system is configured to proxy RADIUS authentication messages.

Parameters:subAcctName - the name of the subscriber account to authenticatesubAcctPassword - the subscriber account password used for authentication

Returns:true if the subscriber account name and password combination are successfully authenticated; otherwise returns false

Exceptions:RemoteException - if an unexpected error occursSQLException - if a database access error occursVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and noneof the external RADIUS servers replies to the authentication requestVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and thereis an error communicating with one of the external RADIUS serversVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and oneof the specified external RADIUS servers is unknownVerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOpPM databaseVerifyException - if there is an error verifying the encoded subAcctPassword

Since:1.1.3

authenticateSubscriberSessionpublic boolean authenticateSubscriberSession(java.lang.String ipAddr, java.lang.String subAcctPassword) throws InvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException, VerifyException

Verifies that the subscriber account associated with the specified subscriber session, and the subscriber account password,exist in the NetOp PM database, or in an external RADIUS server if the NetOp PM system is configured to proxy RADIUSauthentication messages. This method assumes that the subscriber is currently logged on.

Parameters:ipAddr - the IP address of the PC on which the subscriber is attempting to authenticate the subscriber account

Page 47

com.redback.npm.api.auth.AuthenticationIfc


subAcctPassword - the subscriber account password used for authentication

Returns:true if the subscriber account and password combination are successfully authenticated; otherwise returns false

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occursVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and noneof the external RADIUS servers replies to the authentication requestVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and thereis an error communicating with one of the external RADIUS serversVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and oneof the specified external RADIUS servers is unknownVerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOpPM databaseVerifyException - if there is an error verifying the encoded subAcctPassword

Since:1.1.3

authenticateSubscriberSessionWithReplypublic AuthenticationReply authenticateSubscriberSessionWithReply(java.lang.StringipAddr, java.lang.StringsubAcctPassword) throwsInvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException, VerifyException

Verifies that the subscriber account associated with the specified subscriber session, and the subscriber account password,exist in the NetOp PM database, or in an external RADIUS server if the NetOp PM system is configured to proxy RADIUSauthentication messages. This method assumes that the subscriber is currently logged on.

Parameters:ipAddr - the IP address of the PC on which the subscriber is attempting to authenticate the subscriber accountsubAcctPassword - the subscriber account password used for authentication

Returns:an Authentication Reply object that contains the result of authenticating the subscriber account name and password

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occursVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and noneof the external RADIUS servers replies to the authentication requestVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and thereis an error communicating with one of the external RADIUS serversVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and oneof the specified external RADIUS servers is unknownVerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOpPM databaseVerifyException - if there is an error verifying the encoded subAcctPassword

Since:1.2.4

Page 48


authenticateSubscriberWithReplypublic AuthenticationReply authenticateSubscriberWithReply(java.lang.StringsubAcctName, java.lang.StringsubAcctPassword) throws java.rmi.RemoteException, java.sql.SQLException, VerifyException

Verifies that the specified subscriber account name and password exist in the NetOp PM database, or in an externalRADIUS server if the NetOp PM system is configured to proxy RADIUS authentication messages.

Parameters:subAcctName - the name of the subscriber account to authenticatesubAcctPassword - the subscriber account password used for authentication


Exceptions:RemoteException - if an unexpected error occursSQLException - if a database access error occursVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and noneof the external RADIUS servers replies to the authentication requestVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and thereis an error communicating with one of the external RADIUS serversVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and oneof the specified external RADIUS servers is unknownVerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOpPM databaseVerifyException - if there is an error verifying the encoded subAcctPassword

Since:1.2.4

bindSubscriberToSessionpublic void bindSubscriberToSession(java.lang.String ipAddr, java.lang.String subAcctName) throws InvalidIPAddressException, InvalidSubscriberAccountException, java.rmi.RemoteException, SessionAlreadyBoundException, SessionLimitException, java.sql.SQLException, VerifyException

Binds a subscriber to an existing session associated with the specified IP address. If the subscriber account does not exist, itis automatically created and activated. It is assumed that the subscriber is pre- authenticated outside of the NetOp PMsystem.

Parameters:ipAddr - the IP address of the PC on which the subscriber is being bound tosubAcctName - the name of the subscriber account to bind

Exceptions:InvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM systemInvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PMsystem. For example, the subAcctNameis empty or contains too many charactersRemoteException - if an unexpected error occursSessionAlreadyBoundException - if the session for the given IP address is already bound to anothersubscriber

Page 49



SessionLimitException - if the subscriber has already logged in with the maximum number of loginsdefined by their selected services and the services are not defined to automatically log off the oldest login.SQLException - if a database access error occursVerifyException - if a location lock exists for the subscriber but the session is from a wrong location

bindSubscriberToSessionAndApplyServicespublic void bindSubscriberToSessionAndApplyServices(java.lang.String ipAddr, java.lang.String subAcctName) throws InvalidIPAddressException, InvalidSubscriberAccountException, java.rmi.RemoteException, SessionAlreadyBoundException, SessionLimitException, java.sql.SQLException, VerifyException

Binds a subscriber to an existing session associated with the specified IP address and applies existing services to thesession. If the subscriber account does not exist, it is automatically created and activated.

Parameters:ipAddr - the IP address of the PC on which the subscriber is being bound tosubAcctName - the name of the subscriber account to bind

Exceptions:InvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM systemInvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PMsystem. For example, the subAcctNameis empty or contains too many charactersRemoteException - if an unexpected error occursSessionAlreadyBoundException - if the session for the given IP address is already bound to anothersubscriberSessionLimitException - if the subscriber has already logged in with the maximum number of loginsdefined by their selected services and the services are not defined to automatically log off the oldest login.SQLException - if a database access error occursVerifyException - if a location lock exists for the subscriber but the session is from a wrong location; if thereis an error communicating with the node when any of the following conditions are true: 1) the NAS type is notsupported; 2) the CoA feature is not supported for the node. For example, earlier versions of the SmartEdge OS); 3)the CoA request failed (with CoA-NAK).

bindSubscriberToNASUserpublic void bindSubscriberToNASUser(java.lang.String nasUserName, java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, SessionAlreadyBoundException, SessionLimitException, java.sql.SQLException, VerifyException

Binds a subscriber to an existing session associated with the specified NAS user. If the subscriber account does not exist, itis automatically created and activated. If the NAS user does not exist, it is also automatically created. It is assumed that thesubscriber is pre- authenticated outside of the NetOp PM system.

Parameters:nasUserName - the NAS user of the PC on which the subscriber is being bound tosubAcctName - the name of the subscriber account to bind

Exceptions:InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PMsystem. For example, the subAcctNameis empty or contains too many charactersRemoteException - if an unexpected error occursSessionAlreadyBoundException - if the session for any IP address of the given NAS user is already boundto another subscriberSessionLimitException - if the subscriber has already logged in with the maximum number of loginsdefined by their selected services and the services are not defined to automatically logoff the oldest login.

Page 50



SQLException - if a database access error occursVerifyException - if a location lock exists for the subscriber but some session of the NAS user is from anincorrect location

bindSubscriberToNASUserAndApplyServicespublic void bindSubscriberToNASUserAndApplyServices(java.lang.String nasUser, java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, SessionAlreadyBoundException, SessionLimitException, java.sql.SQLException, VerifyException

Binds a subscriber to an existing session associated with the specified NAS user and applies existing services to thesession. If the subscriber account does not exist, it is automatically created and activated. If the NAS user does not exist, itis also automatically created.

Parameters:nasUser - the NAS user of the PC on which the subscriber is being bound tosubAcctName - the name of the subscriber account to bind

Exceptions:InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PMsystem. For example, the subAcctNameis empty or contains too many charactersRemoteException - if an unexpected error occursSessionAlreadyBoundException - if the session for any IP address of the given NAS user is already boundto another subscriberSessionLimitException - if the subscriber is already logged in with the maximum number of logins definedby their selected services, and the services are not defined to automatically log off the oldest login.SQLException - if a database access error occursVerifyException - if a location lock exists for the subscriber but the session is from a wrong location; if thereis an error communicating with the node when any of the following conditions are true: 1) the NAS type is notsupported; 2) the CoA feature is not supported for the node. For example, earlier versions of the SmartEdge OS); 3)the CoA request failed (with CoA-NAK).

logoffNASUserNamepublic boolean logoffNASUserName(java.lang.String nasUserName) throws InvalidNASUserException, java.rmi.RemoteException, java.sql.SQLException, VerifyException

Logs off all subscriber sessions associated with the specified NAS user name (and internally applies the Captive Portalservice to all subscriber sessions, if applicable). The next time the subscriber starts a web browser, the subscriber must logon to be reauthenticated.

Parameters:nasUserName - the name of the NAS user associated with the subscriber sessions being logged off

Returns:true if the subscriber sessions associated with the NAS user name are successfully logged off and assigned the CaptivePortal service, if applicable; false if any of the sessions could not be logged off

Exceptions:InvalidNASUserException - if nasUserName is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occursVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:

Page 51



1.1.3

logoffSubSessionpublic boolean logoffSubSession(java.lang.String ipAddr) throws InvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException, VerifyException

Logs off the subscriber session associated with the specified IP address and applies the Captive Portal service to thesubscriber session, if applicable. The next time the subscriber starts a web browser, the subscriber must log on to bereauthenticated.

Parameters:ipAddr - the IP address of the PC on which the subscriber session is being logged off

Returns:true if the subscriber session associated with the IP address is successfully logged off and assigned the Captive Portalservice, if applicable; false if the subscriber session could not be logged off

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occursVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.1.3

logoffSubSessionspublic boolean logoffSubSessions(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException, VerifyException

Logs off all subscriber sessions associated with the specified subscriber account name and applies the Captive Portalservice to all subscriber sessions, if applicable.

Parameters:subAcctName - the name of the subscriber account to log off

Returns:true if all subscriber sessions associated with the specified subAcctName are successfully logged off; otherwise false

Exceptions:InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occursVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.1.3

Page 52



logonNASUserNamepublic boolean logonNASUserName(java.lang.String nasUserName, java.lang.String subAcctName, java.lang.String subAcctPassword) throws InvalidNASUserException, java.rmi.RemoteException, SessionLimitException, java.sql.SQLException, VerifyException

Notifies the NetOp PM software that the subscriber session associated with the specified NAS username successfullylogged on.

Parameters:nasUserName - the NAS username for the subscriber session associated with the subscriber account on successfullogonsubAcctName - the name of the subscriber account to authenticatesubAcctPassword - the subscriber account password used for authentication

Returns:true if all subscriber sessions associated with the NAS user were successfully logged on; false if any of the subscribersessions associated with the NAS user could not be logged on

Exceptions:InvalidNASUserException - if nasUserName is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSessionLimitException - if the subscriber has already logged in with the maximum number of loginsdefined by their selected services and the services are not defined to automatically logoff the oldest login.SQLException - if a database access error occursVerifyException - if the specified subAcctName is not validVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and noneof the external RADIUS servers replies to the authentication requestVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and thereis an error communicating with one of the external RADIUS serversVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and oneof the external RADIUS servers is unknownVerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOpPM databaseVerifyException - if there is an error verifying the encoded subAcctPasswordVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.1.3

logonNASUserNameWithReplypublic AuthenticationReply logonNASUserNameWithReply(java.lang.String nasUserName, java.lang.String subAcctName, java.lang.String subAcctPassword) throws InvalidNASUserException, java.rmi.RemoteException, SessionLimitException, java.sql.SQLException, VerifyException

Notifies the NetOp PM software that the subscriber session associated with the specified NAS username successfullylogged on.

Parameters:nasUserName - the NAS username for the subscriber session associated with the subscriber account on successfullogonsubAcctName - the name of the subscriber account to authenticatesubAcctPassword - the subscriber account password used for authentication

Page 53




Exceptions:InvalidNASUserException - if nasUserName is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSessionLimitException - if the subscriber has already logged in with the maximum number of loginsdefined by their selected services and the services are not defined to automatically logoff the oldest login.SQLException - if a database access error occursVerifyException - if the specified subAcctName is not validVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and noneof the external RADIUS servers replies to the authentication requestVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and thereis an error communicating with one of the external RADIUS serversVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and oneof the external RADIUS servers is unknownVerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOpPM databaseVerifyException - if there is an error verifying the encoded subAcctPasswordVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.2.4

logonSubSessionpublic boolean logonSubSession(java.lang.String ipAddr, java.lang.String subAcctName, java.lang.String subAcctPassword) throws InvalidIPAddressException, java.rmi.RemoteException, SessionLimitException, java.sql.SQLException, VerifyException

Notifies the NetOp PM software that the subscriber account is attempting to log on. This method callsauthenticateSubscriberSession and, once authenticated, logs the session on, removing the Captive Portal servicefrom the subscriber session, if applicable.

Parameters:ipAddr - the IP address of the PC on which the subscriber is attempting to authenticate the subscriber accountsubAcctName - the name of the subscriber account to authenticatesubAcctPassword - the subscriber account password used for authentication

Returns:true if the subAcctName and subAcctPassword combination are successfully authenticated and the Captive Portalservice is removed from the subscriber session associated with the ipAddr , if applicable; false if thesubAcctName and subAcctPassword failed authentication or the Captive Portal service was not removed from thesubscriber session

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSessionLimitException - if the subscriber has already logged in with the maximum number of loginsdefined by their selected services and the services are not defined to automatically logoff the oldest login.SQLException - if a database access error occursVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and noneof the external RADIUS servers replies to the authentication requestVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and thereis an error communicating with one of the external RADIUS serversVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and oneof the external RADIUS servers is unknown

Page 54



VerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOpPM databaseVerifyException - if there is an error verifying the encoded subAcctPasswordVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.1.3

logonSubSessionWithReplypublic AuthenticationReply logonSubSessionWithReply(java.lang.String ipAddr, java.lang.String subAcctName, java.lang.String subAcctPassword) throws InvalidIPAddressException, java.rmi.RemoteException, SessionLimitException, java.sql.SQLException, VerifyException

Notifies the NetOp PM software that the subscriber account is attempting to log on. This method callsauthenticateSubscriberSession and, once authenticated, logs the session on, removing the Captive Portal servicefrom the subscriber session, if applicable.

Parameters:ipAddr - the IP address of the PC on which the subscriber is attempting to authenticate the subscriber accountsubAcctName - the name of the subscriber account to authenticatesubAcctPassword - the subscriber account password used for authentication


Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSessionLimitException - if the subscriber has already logged in with the maximum number of loginsdefined by their selected services and the services are not defined to automatically logoff the oldest login.SQLException - if a database access error occursVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and noneof the external RADIUS servers replies to the authentication requestVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and thereis an error communicating with one of the external RADIUS serversVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and oneof the external RADIUS servers is unknownVerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOpPM databaseVerifyException - if there is an error verifying the encoded subAcctPassword VerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.2.4

nasUserNameIsLoggedOnpublic boolean nasUserNameIsLoggedOn(java.lang.String nasUserName) throws InvalidNASUserException, java.rmi.RemoteException, java.sql.SQLException

Determines whether all subscriber sessions associated with the specified NAS username have been successfullyauthenticated and are not currently subscribed to the Captive Portal service, if applicable.

Page 55



Parameters:nasUserName - the name of the NAS user being checked

Returns:true if all subscriber sessions associated with the NAS username are logged on and are not subscribed to the CaptivePortal service, if applicable; false if any of the subscriber sessions are subscribed to the Captive Portal service

Exceptions:InvalidNASUserException - if nasUserName is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

subAcctNameIsLoggedOnpublic boolean subAcctNameIsLoggedOn(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Determines whether the subscriber account associated with the specified subscriber account name has been successfullyauthenticated and is not currently subscribed to the Captive Portal service, if applicable.

Parameters:subAcctName - the name of the subscriber account being checked

Returns:true if the subscriber session is logged on and is not subscribed to the Captive Portal service, if applicable; false if thesubscriber session is subscribed to the Captive Portal service

Exceptions:InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

subSessionIsLoggedOnpublic boolean subSessionIsLoggedOn(java.lang.String ipAddr) throws InvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException

Determines whether the subscriber session associated with the specified IP address has been successfully authenticated andis not currently subscribed to the Captive Portal service, if applicable.

Parameters:ipAddr - the IP address of the PC on which the subscriber is currently logged on

Returns:true if the subscriber session is logged on and is not subscribed to the Captive Portal service, if applicable; false if thesubscriber session is subscribed to the Captive Portal service

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database error occurs

Page 56



Since:1.1.3

subSessionLogoffpublic boolean subSessionLogoff(java.lang.String ipAddr, java.lang.String subAcctPassword) throws InvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException, VerifyException

Authenticates and then logs off the subscriber session associated with the specified IP address, and applies the CaptivePortal service to the subscriber session, if applicable. This method verifies that the subscriber account associated with thespecified subscriber session exists in the NetOp PM database, or in an external RADIUS server if the NetOp PM system isconfigured to proxy RADIUS authentication messages, and then applies the Captive Portal service to the subscribersession, if applicable. The next time the subscriber starts a web browser, the subscriber must log on to be reauthenticated.

Parameters:ipAddr - the IP address of the PC on which the subscriber session is being logged offsubAcctPassword - the subscriber account password used for authentication

Returns:true if the subscriber session is successfully authenticated and the subscriber session associated with the specified IPaddress is assigned the Captive Portal service, if applicable; false if the subscriber session could not be authenticatedor the Captive Portal service was not applied

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occursVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and noneof the external RADIUS servers replies to the authentication requestVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and thereis an error communicating with one of the external RADIUS serversVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and oneof the external RADIUS servers is unknownVerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOpPM databaseVerifyException - if there is an error verifying the encoded subAcctPasswordVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.1.3

subSessionLogoffWithReplypublic AuthenticationReply subSessionLogoffWithReply(java.lang.String ipAddr, java.lang.String subAcctPassword) throws InvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException, VerifyException

Authenticates and then logs off the subscriber session associated with the specified IP address, and applies the CaptivePortal service to the subscriber session, if applicable. This method verifies that the subscriber account associated with thespecified subscriber session exists in the NetOp PM database, or in an external RADIUS server if the NetOp PM system isconfigured to proxy RADIUS authentication messages, and then applies the Captive Portal service to the subscribersession, if applicable. The next time the subscriber starts a web browser, the subscriber must log on to be reauthenticated.

Parameters:ipAddr - the IP address associated with the subscriber session to log offsubAcctPassword - the subscriber account password used for authentication

Page 57



Returns:AuthenticationReply an Authentication Reply object that contains the result of authenticating the subscriber accountname and password

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occursVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and noneof the external RADIUS servers replies to the authentication requestVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and thereis an error communicating with one of the external RADIUS serversVerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and oneof the external RADIUS servers is unknownVerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOpPM databaseVerifyException - if there is an error verifying the encoded subAcctPasswordVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.2.4

Page 58


Package

com.redback.npm.api.service

Page 59


Interface ConfigServiceAttributeVariationTypeIfc

public interface ConfigServiceAttributeVariationTypeIfcextends java.rmi.Remote

ConfigServiceAttributeVariationTypeIfc is a web services endpoint that enables you to retrieve service attribute variation types inthe NetOp PM system.

Methods

getAllServiceAttributeVariationTypesXMLpublic java.lang.String getAllServiceAttributeVariationTypesXML() throwsjava.rmi.RemoteException, java.sql.SQLException

Returns details of all Service Attribute Variation Types from the NetOp PM database.

Returns:the XML representations for all Service Attribute Variation Types in the NetOp PM database


Since:6.1.4.4

getServiceAttributeVariationTypeXMLpublic java.lang.String getServiceAttributeVariationTypeXML(java.lang.StringserviceAttributeVariationTypeName) throwsInvalidServiceAttributeVariationTypeException, java.rmi.RemoteException, java.sql.SQLException

Returns details of the specified Service Attribute Variation Type from the NetOp PM database.

Parameters:serviceAttributeVariationTypeName - the service attribute variation type name

Returns:An XML document containing the Service Attribute Variation type

Exceptions:InvalidServiceAttributeVariationTypeException - if the specified service attribute variation typecannot be found in the system.RemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.4.4

Page 60

com.redback.npm.api.service.ConfigServiceAttributeVariationTypeIfc


Interface ServiceAttributeVariationMgmtIfc

public interface ServiceAttributeVariationMgmtIfcextends java.rmi.Remote

ConfigServiceAttributeVariationTypeIfc is a web services endpoint that enables you to retrieve service attribute variations in theNetOp PM system.

Methods

addServiceAttributeVariationXMLpublic void addServiceAttributeVariationXML(java.lang.StringserviceAttributeVariationXML) throwsDuplicateServiceAttributeVariationException, InvalidLicenseException, InvalidServiceAttributeVariationException, java.rmi.RemoteException, java.sql.SQLException

Adds a new Service Attribute Variation to the NetOp PM database. The details of the Service Attribute Variation arecontained in an XML document.

Parameters:serviceAttributeVariationXML - the XML representation for the new Service Attribute Variation

Exceptions:DuplicateServiceAttributeVariationException - if this service attribute variation already exists inthe NetOp PM databaseInvalidLicenseException - if not licensed for Admission Control FunctionInvalidServiceAttributeVariationException - if the XML representation does not pass thevalidationRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

updateServiceAttributeVariationXMLpublic void updateServiceAttributeVariationXML(java.lang.StringserviceAttributeVariationXML) throws InvalidLicenseException, InvalidServiceAttributeVariationException, java.rmi.RemoteException, ServiceAttributeVariationInUseException, java.sql.SQLException

Updates an existing Service Attribute Variation to the NetOp PM database. The details of the Service Attribute Variationare contained in an XML document.

Parameters:serviceAttributeVariationXML - the XML representation for the Service Attribute Variation

Exceptions:

Page 61

com.redback.npm.api.service.ServiceAttributeVariationMgmtIfc


InvalidLicenseException - if not licensed for Admission Control FunctionInvalidServiceAttributeVariationException - if the service attribute variation with the specifiedname cannot be found in the systemRemoteException - if an unexpected error occursServiceAttributeVariationInUseException - if the service attribute variation with the specified nameis currently in useSQLException - if a database access error occurs

Since:6.1.5

removeServiceAttributeVariationpublic void removeServiceAttributeVariation(java.lang.StringserviceAttributeVariationName) throws InvalidServiceAttributeVariationException, java.rmi.RemoteException, ServiceAttributeVariationInUseException, java.sql.SQLException

Remove an existing Service Attribute Variation to the NetOp PM database.

Parameters:serviceAttributeVariationName - the name for the Service Attribute Variation

Exceptions:InvalidServiceAttributeVariationException - if the service attribute variation with the specifiedname cannot be found in the systemRemoteException - if an unexpected error occursServiceAttributeVariationInUseException - if the service attribute variation with the specified nameis currently in useSQLException - if a database access error occurs

Since:6.1.5

getAllServiceAttributeVariationsXMLpublic java.lang.String getAllServiceAttributeVariationsXML() throws java.rmi.RemoteException, java.sql.SQLException

Get all existing Service Attribute Variations from the NetOp PM database. The details of each Service Attribute Variationare contained in an XML document.

Returns:the XML representation of all Service Attribute Variations


Since:6.1.5

Page 62



getServiceAttributeVariationsByTypeXMLpublic java.lang.String getServiceAttributeVariationsByTypeXML(java.lang.StringserviceAttributeVariationType) throwsInvalidServiceAttributeVariationException, java.rmi.RemoteException, java.sql.SQLException

Get existing Service Attribute Variations by type from the NetOp PM database. The details of each Service AttributeVariation are contained in an XML document.

Parameters:serviceAttributeVariationType - the type of Service Attribute Variation

Returns:the XML representation of the Service Attribute Variation

Exceptions:InvalidServiceAttributeVariationException - if the service attribute variations with the specifiedtype cannot be found in the systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

getServiceAttributeVariationXMLpublic java.lang.String getServiceAttributeVariationXML(java.lang.StringserviceAttributeVariationName) throwsInvalidServiceAttributeVariationException, java.rmi.RemoteException, java.sql.SQLException

Get an existing Service Attribute Variation to the NetOp PM database. The details of the Service Attribute Variation arecontained in an XML document.

Parameters:serviceAttributeVariationName - the name for the Service Attribute Variation

Returns:the XML representation of the Service Attribute Variation

Exceptions:InvalidServiceAttributeVariationException - if the service attribute variation with the specifiedname cannot be found in the systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.1.5

Page 63



Interface ServiceIfc

public interface ServiceIfcextends java.rmi.Remote

ServiceIfc is a web services endpoint that enables you to retrieve, apply, and remove subscriber services.

Methods

addServiceToSubAcctNamepublic void addServiceToSubAcctName(java.lang.String subAcctName, java.lang.String serviceId) throws DuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException

Adds the specified service to the list of services selected by the subscriber account.

Parameters:subAcctName - the name of the subscriber account to which the service is addedserviceId - the internal identifier for the service to be added

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceId already exists in thesubscriber's list of service subscriptions associated with the ipAddrIncompatibleServiceException - if the specified serviceId causes conflict with other selected servicesassociated with the subAcctNameInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the specified serviceId is unknown to the NetOp PM systemInvalidServiceSubscriptionException - if one or more of the required override attributes are missingInvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM systemNoAccessServiceException - if adding the specified serviceId would leave the subscriber with no accessservice; that is, the first service added must be an Access serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified services require a guaranteed bandwidth reservationSQLException - if a database access error occursTooManyServicesSelectedException - if adding the specified serviceId would select too manyservices.UnauthorizedException - if the API user is not authorized to perform the requested task

Since:1.1.3

Page 64

com.redback.npm.api.service.ServiceIfc


addServiceToSubAcctNameXMLpublic void addServiceToSubAcctNameXML(java.lang.String subAcctName, java.lang.String serviceSubscriptionXML) throws DuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidLicenseException, InvalidServiceException, InvalidSubscriberAccountException, InvalidServiceSubscriptionException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException

Adds the specified service subscription to the list of services selected by the subscriber account.

Parameters:subAcctName - the name of the subscriber account to which this service is addedserviceSubscriptionXML - the XML representation for the service subscription to be added

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceId already exists in thesubscriber's list of service subscriptions associated with the ipAddrIncompatibleServiceException - if the specified serviceId causes conflict with other selected servicesassociated with the subAcctNameInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the specified serviceId is unknown to the NetOp PM systemInvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to beoverridden in the NetOp PM system or are not following a valid formatInvalidServiceSubscriptionException - if one or more of the required override attributes are missingInvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM systemNoAccessServiceException - if adding the specified serviceId would leave the subscriber with no accessservice; that is, the first service added must be an Access serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified services require a guaranteed bandwidth reservationSQLException - if a database access error occursTooManyServicesSelectedException - if adding the specified serviceId would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested task

Since:5.0.5

addServiceToSubSessionpublic void addServiceToSubSession(java.lang.String ipAddr, java.lang.String serviceId) throws DuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidIPAddressException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException

Adds the specified service to the list of services selected by the subscriber account associated with the subscriber session.

Page 65



Parameters:ipAddr - the IP address of the PC on which the subscriber account is logged onserviceId - the internal identifier for the service to be added

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceId already exists in thesubscriber's list of service subscriptions associated with the ipAddrIncompatibleServiceException - if the specified serviceId causes conflict with other selected servicesassociated with the ipAddrInvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the specified serviceId is unknown to the NetOp PM systemInvalidServiceSubscriptionException - if one or more of the required override attributes are missingInvalidSubscriberAccountException - if no subscriber account is associated with the subscriber sessionNoAccessServiceException - if adding the specified serviceId would leave the subscriber with no accessservice; that is, the first service added must be an Access serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot bemade at the subscriber homeResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot bemade in the networkSQLException - if a database access error occursTooManyServicesSelectedException - if adding the specified serviceId would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested task

Since:1.1.3

addServiceToSubSessionXMLpublic void addServiceToSubSessionXML(java.lang.String ipAddr, java.lang.String serviceSubscriptionXML) throws DuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidIPAddressException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException

Adds the specified service subscription to the list of services selected by the subscriber account associated with thesubscriber session.

Parameters:ipAddr - the IP address of the PC on which the subscriber account is logged onserviceSubscriptionXML - the XML representation for the service subscription to be added

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceId already exists in thesubscriber's list of service subscriptions associated with the ipAddrIncompatibleServiceException - if the specified serviceId causes conflict with other selected servicesassociated with the ipAddrInvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the specified serviceId is unknown to the NetOp PM system.

Page 66



InvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to beoverridden in the NetOp PM system or are not following a valid formatInvalidServiceSubscriptionException - if one or more of the required override attributes are missingInvalidSubscriberAccountException - if no subscriber account is associated with the subscriber sessionNoAccessServiceException - if adding the specified serviceId would leave the subscriber with no accessservice; that is, the first service added must be an Access serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot bemade at the subscriber homeResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot bemade in the networkSQLException - if a database access error occursTooManyServicesSelectedException - if adding the specified serviceId would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested task

Since:5.0.5

applyServicesToSubAcctNamepublic void applyServicesToSubAcctName(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException, VerifyException

Instructs the node to apply the services selected by the subscriber account to all associated subscriber sessions.

Parameters:subAcctName - the name of the subscriber account to which services are applied

Exceptions:InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occursVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.1.3

applyServicesToSubSessionpublic void applyServicesToSubSession(java.lang.String ipAddr) throws InvalidIPAddressException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException, VerifyException

Instructs the node to apply the services selected by the subscriber account to all associated subscriber sessions.

Parameters:ipAddr - the IP address of the PC on which the subscriber account is logged on

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemInvalidSubscriberAccountException - if no subscriber account is associated with the subscriber sessionRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Page 67



VerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.1.3

changeAndApplyServicesToSubAcctNamepublic void changeAndApplyServicesToSubAcctName(java.lang.String subAcctName, java.lang.String[] serviceIds) throws DuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException, VerifyException

Changes the list of serviceIds to the specified array of serviceIds selected by the subscriber account and instructsthe node to apply the services to all associated subscriber sessions.

Parameters:subAcctName - the name of the subscriber account for which services are being modified and appliedserviceIds - the array of internal identifiers for the services to be added

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceIds contain duplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service identifier that causesconflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to theNetOp PM systemInvalidServiceSubscriptionException - if the specified serviceIds require attribute overridesInvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PMsystemNoAccessServiceException - if changing the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified services require a guaranteed bandwidth reservationSessionLimitException - if the specified services allow fewer sessions than the subscriber has currentlylogged in and that the current services are not defined to automatically log off the old sessionsSQLException - if a database access error occursTooManyServicesSelectedException - if changing the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested taskVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.1.3

Page 68



changeAndApplyServicesToSubAcctNameXMLpublic void changeAndApplyServicesToSubAcctNameXML(java.lang.String subAcctName, java.lang.StringserviceSubscriptionsXML) throwsDuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException, VerifyException

Changes the list of service subscriptions to the specified service subscriptions and instructs the node to apply the services toall associated subscriber sessions.

Parameters:subAcctName - the name of the subscriber account for which services are being modified and appliedserviceSubscriptionsXML - the XML representation for the service subscriptions

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceIds contain duplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service identifier that causesconflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to theNetOp PM systemInvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to beoverridden in the NetOp PM system or are not following a valid formatInvalidServiceSubscriptionException - if one or more of the required override attributes are missingInvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PMsystemNoAccessServiceException - if changing the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified services require a guaranteed bandwidth reservationSessionLimitException - if the specified services allow fewer sessions than the subscriber has currentlylogged in and that the current services are not defined to automatically log off the old sessionsSQLException - if a database access error occursTooManyServicesSelectedException - if changing the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested taskVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed; 4) if one or more of the specified attributes are not allowed to be overridden in theNetOp PM system or the value specified does not follow a valid format

Since:5.0.5

Page 69



changeAndApplyServicesToSubSessionpublic void changeAndApplyServicesToSubSession(java.lang.String ipAddr, java.lang.String[] serviceIds) throws DuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidIPAddressException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException, VerifyException

Changes the list of serviceIds to the specified array of serviceIds selected by the subscriber account associated withthe subscriber session and instructs the node to apply the services to all associated subscriber sessions.

Parameters:ipAddr - the IP address of the PC on which the subscriber account is logged onserviceIds - the array of internal identifiers for the services to be added

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceIds contain duplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service identifier that causesconflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceSubscriptionException - if the specified serviceIds require attribute overridesInvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM systemInvalidServiceException - if the specified serviceIds contain a service id that is unknown to the NetOpPM systemInvalidSubscriberAccountException - if no subscriber account is associated with the subscriber sessionNoAccessServiceException - if changing the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot bemade at the subscriber homeResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot bemade in the networkSessionLimitException - if the specified services allow fewer sessions than the subscriber has currentlylogged in and that the current services are not defined to automatically log off the old sessionsSQLException - if a database access error occursTooManyServicesSelectedException - if changing the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested taskVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.1.3

Page 70



changeAndApplyServicesToSubSessionXMLpublic void changeAndApplyServicesToSubSessionXML(java.lang.String ipAddr, java.lang.StringserviceSubscriptionsXML) throwsDuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidIPAddressException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException, VerifyException

Changes the list of service subscriptions to the specified service subscriptions from the XML input file and instructs thenode to apply the services to all associated subscriber sessions.

Parameters:ipAddr - the IP address of the PC on which the subscriber account is logged onserviceSubscriptionsXML - the XML representation for the service subscriptions

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceSubscriptionsXML containsduplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service identifier that causesconflictsInvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM systemInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to theNetOp PM systemInvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to beoverridden in the NetOp PM system or are not following a valid formatInvalidServiceSubscriptionException - if one or more of the required override attributes are missingInvalidSubscriberAccountException - if no subscriber account is associated with the subscriber sessionNoAccessServiceException - if changing the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot bemade at the subscriber homeResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot bemade in the networkSessionLimitException - if the specified services allow fewer sessions than the subscriber has currentlylogged in and that the current services are not defined to automatically log off the old sessionsSQLException - if a database access error occursTooManyServicesSelectedException - if changing the specified serviceIds would select too manyservicesVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed; 4) if one or more of the specified attributes are not allowed to be overridden in theNetOp PM system or the value specified does not follow a valid format

Since:5.0.5

Page 71



changeAndApplyWholesaleServicesToSubAcctNamepublic void changeAndApplyWholesaleServicesToSubAcctName(java.lang.String subAcctName, java.lang.String[]serviceIds) throwsDuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException, VerifyException

Deprecated. 5.0.5 Do not use this method.

Changes the list of wholesale serviceIds to the specified array of serviceIds selected by the subscriber account andinstructs the node to apply the wholesale services to all associated subscriber sessions.

Parameters:subAcctName - the name of the subscriber account for which services are being modified and appliedserviceIds - the array of internal identifiers for the wholesale services to be added

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceIds contain duplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service identifier that causesconflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to theNetOp PM systemInvalidServiceSubscriptionException - if the specified serviceIds require attribute overridesInvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PMsystemNoAccessServiceException - if changing the specified serviceIds would leave the subscriber with noaccess service.RemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified services require a guaranteed bandwidth reservationSessionLimitException - if the specified services allow fewer sessions than the subscriber has currentlylogged in and that the current services are not defined to automatically log off the old sessionsSQLException - if a database access error occursTooManyServicesSelectedException - if changing the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested taskVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.2.4

Page 72



changeAndApplyWholesaleServicesToSubSessionpublic void changeAndApplyWholesaleServicesToSubSession(java.lang.String ipAddr, java.lang.String[] serviceIds) throwsDuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidIPAddressException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException, VerifyException


Changes the list of wholesale serviceIds to the specified array of serviceIds selected by the subscriber accountassociated with the subscriber session and instructs the node to apply the wholesale services to all associated subscribersessions.

Parameters:ipAddr - the IP address of the PC on which the subscriber account is logged onserviceIds - the array of internal identifiers for the services to be added

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceIds contain duplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service identifier that causesconflictsInvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM systemInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to theNetOp PM systemInvalidServiceSubscriptionException - if the specified serviceIds require attribute overridesInvalidSubscriberAccountException - if no subscriber account is associated with the subscriber sessionNoAccessServiceException - if changing the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot bemade at the subscriber homeResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot bemade in the networkSessionLimitException - if the specified services allow fewer sessions than the subscriber has currentlylogged in and that the current services are not defined to automatically log off the old sessionsSQLException - if a database access error occursTooManyServicesSelectedException - if changing the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested taskVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:1.2.4

Page 73


changeServicesForSubAcctNameXMLpublic void changeServicesForSubAcctNameXML(java.lang.String subAcctName, java.lang.String serviceSubscriptionsXML) throws DuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidLicenseException, InvalidServiceException, InvalidSubscriberAccountException, InvalidServiceSubscriptionException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException, VerifyException

Changes the list of service subscriptions to the specified ones.

Parameters:subAcctName - the name of the subscriber account for which services are being changedserviceSubscriptionsXML - the XML representation for the service subscriptions

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceSubscriptionsXML containsduplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service identifier that causesconflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to theNetOp PM systemInvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to beoverridden in the NetOp PM system or are not following a valid formatInvalidServiceSubscriptionException - if one or more of the required override attributes are missingInvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PMsystemNoAccessServiceException - if changing the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified services require a guaranteed bandwidth reservationSessionLimitException - if the specified services allow fewer sessions than the subscriber has currentlylogged in and that the current services are not defined to automatically log off the old sessionsSQLException - if a database acceess error occursTooManyServicesSelectedException - if changing the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested taskVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed; 4) if one or more of the specified attributes are not allowed to be overridden in theNetOp PM system or the value specified does not follow a valid format

Since:5.0.5

Page 74



changeServicesForSubSessionXMLpublic void changeServicesForSubSessionXML(java.lang.String ipAddr, java.lang.String serviceSubscriptionsXML) throws DuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidIPAddressException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException, VerifyException

Changes the list of service subscriptions to the specified ones.

Parameters:ipAddr - the IP address of the PC on which the subscriber account is logged onserviceSubscriptionsXML - the XML representation for the service subscriptions

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceSubscriptionsXML containsduplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service identifier that causesconflictsInvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM systemInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services Featurecom.redback.npm.common.InvalidServiceException - if the specified serviceIds contain aservice identifier that is unknown to the NetOp PM systemInvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to beoverridden in the NetOp PM system or are not following a valid formatInvalidServiceSubscriptionException - if one or more of the required override attributes are missingInvalidSubscriberAccountException - if no subscriber account is associated with the subscriber sessionNoAccessServiceException - if changing the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot bemade at the subscriber homeResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot bemade in the networkSessionLimitException - if the specified services allow fewer sessions than the subscriber has currentlylogged in and that the current services are not defined to automatically log off the old sessionsSQLException - if a database access error occursTooManyServicesSelectedException - if changing the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested taskVerifyException - if there is an error communicating with the node when any of the following conditions aretrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed; 4) if one or more of the specified attributes are not allowed to be overridden in theNetOp PM system or the value specified does not follow a valid format

Since:5.0.5

Page 75



getAvailableServicesForSubSessionpublic ServiceListEntry[] getAvailableServicesForSubSession(java.lang.String ipAddr) throws InvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of service identifiers and service names for the retail services that are available to be selected by thesubscriber session hosted on the specified realm, node type, circuit type, and medium type, such as NAS port type.


Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of the retail servicescurrently available to the specified subscriber session.

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

getAvailableWholesaleServicesForSubSessionpublic ServiceListEntry[] getAvailableWholesaleServicesForSubSession(java.lang.StringipAddr) throwsInvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException


Returns a list of service identifiers and service names for the wholesale services that are available to be selected by thesubscriber session hosted on the specified realm, node type, circuit type, and medium type (NAS port type).


Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of the wholesale servicescurrently available to the specified subscriber session.

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

Page 76



getMeteredTimeUsageForSubAcctNamepublic MeteredTimeUsage[] getMeteredTimeUsageForSubAcctName(java.lang.StringsubAcctName) throwsInvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of time-based usage statistics for the specified subscriber account.

Parameters:subAcctName - the name of the subscriber account

Returns:an array of MeteredTimeUsage objects containing usage statistics for the specified subscriber

Exceptions:InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PMsystemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

getMeteredTimeUsageForSubSessionpublic MeteredTimeUsage[] getMeteredTimeUsageForSubSession(java.lang.String ipAddr) throws InvalidIPAddressException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of time-based usage statistics for the specified subscriber session. Returns zero usage if time-metered servicesare not supported for the specified subscriber session.


Returns:an array of MeteredTimeUsage objects containing usage statistics for the specified subscriber

Exceptions:InvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM systemInvalidSubscriberAccountException - if no subscriber account is associated with the subscriber sessionRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

getMeteredVolumeUsageForSubAcctNamepublic MeteredVolumeUsage[] getMeteredVolumeUsageForSubAcctName(java.lang.StringsubAcctName) throwsInvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of volume-based usage statistics for the specified subscriber account.

Page 77




Returns:an array of MeteredVolumeUsage objects containing usage statistics for the specified subscriber


Since:2.0

getMeteredVolumeUsageForSubSessionpublic MeteredVolumeUsage[] getMeteredVolumeUsageForSubSession(java.lang.StringipAddr) throwsInvalidIPAddressException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of volume-based usage statistics for the specified subscriber session. Returns zero usage if volume-meteredservices are not supported for the specified subscriber session.


Returns:an array of MeteredVolumeUsage objects containing usage statistics for the specified subscriber

Exceptions:InvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM systemInvalidSubscriberAccountException - if no subscriber account is associated with the subscriber sessionRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

getSelectedServicesForSubAcctNamepublic ServiceListEntry[] getSelectedServicesForSubAcctName(java.lang.StringsubAcctName) throwsInvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of retail service identifiers and service names selected by the specified subscriber account.


Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of the retail servicescurrently selected by the subscriber account associated with the specified subAcctName

Page 78




Since:1.1.3

getSelectedServicesForSubSessionpublic ServiceListEntry[] getSelectedServicesForSubSession(java.lang.String ipAddr) throws InvalidIPAddressException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of retail service IDs and service names selected by the subscriber account associated with this subscribersession.


Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of the retail servicescurrently selected by the specified subscriber session.

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemInvalidSubscriberAccountException - if no subscriber account is associated with this subscribersessionRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

getSelectedWholesaleServicesForSubAcctNamepublic ServiceListEntry[] getSelectedWholesaleServicesForSubAcctName(java.lang.StringsubAcctName) throwsInvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException


Returns a list of wholesale service identifiers and service names selected by the specified subscriber account.

Parameters:subAcctName - name of the subscriber account for which wholesale services are being retrieved

Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of the wholesale servicescurrently selected by the subscriber account associated with the specified subAcctName

Exceptions:InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM systemRemoteException - if an unexpected error occurs

Page 79



SQLException - if a database access error occurs

Since:1.1.3

getSelectedWholesaleServicesForSubSessionpublic ServiceListEntry[] getSelectedWholesaleServicesForSubSession(java.lang.StringipAddr) throwsInvalidIPAddressException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException


Returns a list of wholesale service identifiers and service names selected by this subscriber account associated with thesubscriber session.


Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of the wholesale servicescurrently selected by the specified subscriber session.


Since:1.1.3

getServiceOrderHistorypublic ServiceOrder[] getServiceOrderHistory(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns the service order history for the given subscriber account.

Parameters:subAcctName - the name of the subscriber account for which this service order history is being retrieved

Returns:a List of ServiceOrder objects sorted in order from newest to oldest


Since:2.0

Page 80


getServiceSubscriptionspublic ServiceSubscription[] getServiceSubscriptions(java.lang.String subAcctName) throwsInvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns the service subscriptions for this subscriber account.

Parameters:subAcctName - the name of the subscriber account for which subscriptions are being retrieved

Returns:a List of ServiceSubscription objects


Since:2.0

removeAllServicespublic void removeAllServices(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Removes all retail services selected by the subscriber account.

Parameters:subAcctName - the name of the subscriber account from which all retail services are being removed


Since:1.1.3

removeAllServicesFromSubSessionpublic void removeAllServicesFromSubSession(java.lang.String ipAddr) throws InvalidIPAddressException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Removes all retail services selected by the subscriber account associated with this subscriber session.


Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemInvalidSubscriberAccountException - if no subscriber account is associated with this subscribersession

Page 81



RemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

removeAllWholesaleServicespublic void removeAllWholesaleServices(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException


Removes all wholesale services selected by the subscriber account.

Parameters:subAcctName - the name of the subscriber account for which all wholesale services are being removed


Since:1.1.3

removeAllWholesaleServicesFromSubSessionpublic void removeAllWholesaleServicesFromSubSession(java.lang.String ipAddr) throws InvalidIPAddressException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException


Removes all wholesale services selected by the subscriber account associated with this subscriber session.



Since:1.1.3

Page 82



removeServicepublic void removeService(java.lang.String subAcctName, java.lang.String serviceId) throws InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, java.sql.SQLException, UnauthorizedException

Removes the specified service from the list of services selected by the specified subscriber account.

Parameters:subAcctName - the name of the subscriber account from which this service is being removedserviceId - the internal identifier for the service to be removed

Exceptions:InvalidServiceException - if the specified serviceId is unknown to the NetOp PM systemInvalidServiceSubscriptionException - if the specified subAcctName has not subscribed to theserviceIdInvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM systemNoAccessServiceException - if removing the specified serviceId would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursSQLException - if a database access error occursUnauthorizedException - if the API user is not authorized to perform the requested task

Since:1.1.3

removeServiceFromSubSessionpublic void removeServiceFromSubSession(java.lang.String ipAddr, java.lang.String serviceId) throws InvalidIPAddressException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, java.sql.SQLException, UnauthorizedException

Removes the specified service from the list of services selected by the subscriber account associated with this subscribersession.

Parameters:ipAddr - the IP address of the PC on which the subscriber account is logged onserviceId - the internal identifier for the service to be removed

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemInvalidServiceException - if the specified serviceId is unknown to the NetOp PM systemInvalidServiceSubscriptionException - if the specified ipAddr associated with thissubAcctName has not subscribed to the serviceIdInvalidSubscriberAccountException - if no subscriber account is associated with this subscribersessionNoAccessServiceException - if removing the specified serviceId would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursSQLException - if a database access error occursUnauthorizedException - if the API user is not authorized to perform the requested task

Page 83



Since:1.1.3

resetAllMeteredUsagepublic void resetAllMeteredUsage() throws java.rmi.RemoteException, java.sql.SQLException

Resets time and volume usage for all custom metered service subscriptions for all subscribers on all nodes.


Since:2.0

resetMeteredUsageForNASpublic void resetMeteredUsageForNAS(java.lang.String nasId) throws InvalidNASException, java.rmi.RemoteException, java.sql.SQLException

Resets time and volume usage for all custom metered service subscriptions for all subscribers on the specified node.

Parameters:nasId - the identifier of the node for which to reset subscriber usage

Exceptions:InvalidNASException - if the specified nasId is unknown to the NetOp NPM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

resetMeteredUsageForServicepublic void resetMeteredUsageForService(java.lang.String serviceId) throws InvalidServiceException, java.rmi.RemoteException, java.sql.SQLException

Resets time and volume usage for all custom metered service subscriptions with the specified service identifier.

Parameters:serviceId - the service identifier for which to reset subscriber usage

Exceptions:InvalidServiceException - if the serviceId specified in the ServiceOffering object does not exist in theNetOp PM databaseRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:6.0

Page 84



resetMeteredUsageForSubAcctNamepublic void resetMeteredUsageForSubAcctName(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Resets time and volume usage for all custom metered service subscriptions for the specified subscriber account.

Parameters:subAcctName - the name of the subscriber account for which to reset usage


Since:2.0

reactivateAndApplyServicesToSubAcctNamepublic void reactivateAndApplyServicesToSubAcctName(java.lang.String subAcctName, java.lang.String[] serviceIds) throwsDuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException, VerifyException

Reactivates the list of serviceIds to the specified array of serviceIds selected by the subscriber account and instructs thenode to apply the services to all associated subscriber sessions.

Parameters:subAcctName - the name of the subscriber account for which services are being reactivated and appliedserviceIds - the array of internal identifiers for the services to be reactivated

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceIds contains duplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service id that causes conflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the specified serviceIds contain a service id that is unknown to NetOpPM SystemInvalidServiceSubscriptionException - if the specified serviceIds require attribute overridesInvalidServiceSubscriptionException - if the specified serviceIds is not already subscribed to bythe subscriber accountInvalidSubscriberAccountException - if the specified subAcctName is unknown to NetOp PMSystemNoAccessServiceException - if changing the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified service(s) require a guaranteed bandwidth reservation

Page 85



SessionLimitException - if the specified service(s) allow fewer sessions than the subscriber has currentlylogged in and that the current service(s) are not defined to automatically logoff the old sessionsSQLException - if a database error occursTooManyServicesSelectedException - if changing the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested taskVerifyException - if there is an error communicating with the node when any of the following conditions istrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:6.1.0

reactivateAndApplyServicesToSubSessionpublic void reactivateAndApplyServicesToSubSession(java.lang.String ipAddr, java.lang.String[] serviceIds) throwsDuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidIPAddressException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException, VerifyException

Reactivates the list of serviceIds to the specified array of serviceIds selected by the subscriber account associated with thesubscriber session and instructs the node to apply the services to all associated subscriber sessions.

Parameters:ipAddr - the IP address of the PC on which the subscriber account is logged onserviceIds - the array of internal identifiers for the services to be reactivated

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceIds contains duplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service id that causes conflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceSubscriptionException - if the specified serviceIds require attribute overridesInvalidServiceSubscriptionException - if the specified serviceIds is not already subscribed to bythe subscriber accountInvalidIPAddressException - if the specified ipAddr is unknown to NetOp PM SystemInvalidServiceException - if the specified serviceIds contain a service id that is unknown to NetOpPM System unknown to NetOp PM SystemInvalidSubscriberAccountException - if no subscriber account is associated with the subscriber sessionNoAccessServiceException - if changing the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified service(s) guaranteed bandwidth reservation can notbe made at the subscriber homeResourceRequestDeniedException - if the specified service(s) guaranteed bandwidth reservation can notbe made in the networkSessionLimitException - if the specified service(s) allow fewer sessions than the subscriber has currentlylogged in and that the current service(s) are not defined to automatically logoff the old sessionsSQLException - if a database error occursTooManyServicesSelectedException - if changing the specified serviceIds would select too manyservices

Page 86



UnauthorizedException - if the API user is not authorized to perform the requested taskVerifyException - if there is an error communicating with the node when any of the following conditions istrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:6.1.0

reactivateServicesForSubAcctNamepublic void reactivateServicesForSubAcctName(java.lang.String subAcctName, java.lang.String[] serviceIds) throws DuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidLicenseException, InvalidServiceException, InvalidSubscriberAccountException, InvalidServiceSubscriptionException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException, VerifyException

Reactivates the list of service subscriptions

Parameters:subAcctName - the name of the subscriber account for which services are being reactivatedserviceIds - the array of internal identifiers for the services to be reactivated

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceSubscriptionsXML containsduplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service id that causes conflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the specified serviceIds contain a service id that is unknown to NetOpPM SystemInvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to beoverridden in NPM or are not following a valid formatInvalidServiceSubscriptionException - if the specified serviceIds is not already subscribed to bythe subscriber accountInvalidSubscriberAccountException - if the specified subAcctName is unknown to NetOp PMSystemNoAccessServiceException - if changing the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified service(s) require a guaranteed bandwidth reservationSessionLimitException - if the specified service(s) allow fewer sessions than the subscriber has currentlylogged in and that the current service(s) are not defined to automatically logoff the old sessionsSQLException - if a database error occursTooManyServicesSelectedException - if changing the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested taskVerifyException - if there is an error communicating with the node when any of the following conditions istrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed; 4) if one or more of the specified attributes are not allowed to be overridden inNPM or the value specified does not follow a valid format

Since:6.1.0

Page 87



reactivateServicesForSubSessionpublic void reactivateServicesForSubSession(java.lang.String ipAddr, java.lang.String[] serviceIds) throws DuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidIPAddressException, InvalidLicenseException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException, VerifyException

Reactivates the list of serviceIds to the specified array of serviceIds selected by the subscriber account associated with thesubscriber session.

Parameters:ipAddr - the IP address of the PC on which the subscriber account is logged onserviceIds - the array of internal identifiers for the services to be reactivated

Exceptions:DuplicateServiceSubscriptionException - if the specified serviceIds contains duplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service id that causes conflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceSubscriptionException - if the specified serviceIds require attribute overridesInvalidServiceSubscriptionException - if the specified serviceIds is not already subscribed to bythe subscriber accountInvalidIPAddressException - if the specified ipAddr is unknown to NetOp PM SystemInvalidServiceException - if the specified serviceIds contain a service id that is unknown to NetOpPM System unknown to NetOp PM SystemInvalidSubscriberAccountException - if no subscriber account is associated with the subscriber sessionNoAccessServiceException - if changing the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if the specified service(s) guaranteed bandwidth reservation can notbe made at the subscriber homeResourceRequestDeniedException - if the specified service(s) guaranteed bandwidth reservation can notbe made in the networkSessionLimitException - if the specified service(s) allow fewer sessions than the subscriber has currentlylogged in and that the current service(s) are not defined to automatically logoff the old sessionsSQLException - if a database error occursTooManyServicesSelectedException - if changing the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested taskVerifyException - if there is an error communicating with the node when any of the following conditions istrue: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configurationfile; 3) the SNMP message failed

Since:6.1.0

Page 88



Interface ServiceMgmtIfc

public interface ServiceMgmtIfcextends java.rmi.Remote

ServiceMgmtIfc is a web services endpoint that enables you to create, retrieve, and delete services in the NetOp PM database.

Methods

createServiceOfferingXMLpublic void createServiceOfferingXML(java.lang.String serviceXML) throws DuplicateServiceException, InvalidLicenseException, InvalidServiceException, ProcessingFailureException, java.rmi.RemoteException, java.sql.SQLException

Adds a new service definition to the NetOp PM database. Note: The creation date of the service offering is generatedautomatically by the NetOp PM system; any creation date value specified in the details of theServiceOffering parameter is ignored.

Parameters:serviceXML - the XML representation for the service being added to the NetOp PM database.

Exceptions:DuplicateServiceException - if the id specified in the ServiceOffering object already exists in the NetOpPM systemDuplicateServiceException - if the name specified in the ServiceOffering object already exists in theNetOp PM systemInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidServiceException - if the id specified in the ServiceOffering object is not validcom.redback.npm.common.InvalidServiceException - if the name specified in the ServiceOfferingobject is not validProcessingFailureException - if an error occurs while processing the XML documentRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

getAllServiceOfferingTypesXMLpublic java.lang.String getAllServiceOfferingTypesXML() throws ProcessingFailureException, java.rmi.RemoteException

Returns a list of service offering type identifiers and service offering type names for all service offering types defined inthe NetOp PM database.

Returns:an XML representation for the list of all service offering type identifiers and names in the NetOp PM database

Exceptions:ProcessingFailureException - if an error occurs while processing the XML document

Page 89

com.redback.npm.api.service.ServiceMgmtIfc


RemoteException - if an unexpected error occurs

Since:2.0

getAllServicespublic ServiceListEntry[] getAllServices() throws java.rmi.RemoteException, java.sql.SQLException

Returns a list of service identifiers and service names for all retail services defined in the NetOp PM database, regardless ofwhether the showInList flag is set to true or false.

Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of all services in the NetOpPM database


Since:1.1.3

getAllServicesByTypepublic ServiceListEntry[] getAllServicesByType(java.lang.String svcOffrgType) throws java.rmi.RemoteException, java.sql.SQLException

Returns a list of service identifiers and service names for all retail services of this type defined in the NetOp PM database,regardless whether the showInList flag is set to true or false.

Parameters:svcOffrgType - the type of service offerings defined

Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of all services in the NetOpPM database


Since:2.0

getAllWholesaleServicespublic ServiceListEntry[] getAllWholesaleServices() throws java.rmi.RemoteException, java.sql.SQLException


Returns a list of service identifiers and service names for all wholesale services defined in the NetOp PM database,regardless whether the showInList flag is set to true or false.

Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of all wholesale services inthe NetOp PM database

Page 90




Since:1.1.3

getAvailableRealmServicespublic ServiceListEntry[] getAvailableRealmServices(java.lang.String realm) throws java.rmi.RemoteException, java.sql.SQLException

Returns a list of service identifiers and service names for all retail services that are available to the specified realm, andwhere the showInList flag is set to true.

Parameters:realm - the name of the realm used to retrieve available retail services

Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of the retail services in theNetOp PM database available to the specified realm


Since:1.1.3

getAvailableRealmWholesaleServicespublic ServiceListEntry[] getAvailableRealmWholesaleServices(java.lang.String realm) throws java.rmi.RemoteException, java.sql.SQLException


Returns a list of service identifiers and service names for all wholesale services that are available to the specified realm,and where the showInList flag is set to true.

Parameters:realm - the name of the realm used to retrieve available wholesale services

Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of the wholesale services inthe NetOp PM database available to the specified realm


Since:1.1.3

getAvailableServicespublic ServiceListEntry[] getAvailableServices() throws java.rmi.RemoteException, java.sql.SQLException

Returns a list of service identifiers and service names for all retail services that are available to the default realm, andwhere the showInList flag is set to true.

Page 91



Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of the retail services in theNetOp PM database available to the default realm


Since:1.1.3

getAvailableWholesaleServicespublic ServiceListEntry[] getAvailableWholesaleServices() throws java.rmi.RemoteException, java.sql.SQLException


Returns a list of service identifiers and service names for all wholesale services that are available to the default realm, andwhere the showInList flag is set to true.

Returns:an array of ServiceListEntry objects that contain the service identifiers and service names of the wholesale services inthe NetOp PM database available to the default realm


Since:1.1.3

getServiceDetailsXMLpublic java.lang.String getServiceDetailsXML(java.lang.String serviceId) throws InvalidServiceException, java.rmi.RemoteException, java.sql.SQLException

Returns the details of the specified retail service for all realms.

Parameters:serviceId - the internal identifier of the service for which to return details

Returns:an XML representation for the service associated with the specified serviceId

Exceptions:com.redback.npm.common.InvalidServiceException - if the specified serviceId does not exist inthe NetOp PM databaseRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

Page 92



getServiceDetailsXMLForRealmpublic java.lang.String getServiceDetailsXMLForRealm(java.lang.String realm, java.lang.String serviceId) throws InvalidServiceException, java.rmi.RemoteException, java.sql.SQLException


Returns the details of the specified retail service for the specified realm.

Parameters:realm - the name of the realm used to retrieve service detailsserviceId - the internal identifier of the service for which to return details

Returns:an XML representation for the service associated with the specified serviceId

Exceptions:InvalidServiceException - if the specified serviceId does not exist in the NetOp PM databaseRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.2.4

removeServiceOfferingpublic void removeServiceOffering(java.lang.String serviceId) throws InvalidServiceException, java.rmi.RemoteException, ServiceInUseException, java.sql.SQLException

Removes a service offering from the NetOp PM database.

Parameters:serviceId - the internal identifier of the service to be removed from the database

Exceptions:InvalidServiceException - if the specified serviceId does not exist in the NetOp PM databaseRemoteException - if an unexpected error occurs in the NetOp PM databaseServiceInUseException - if any subscriber is subscribed to the specified serviceIdSQLException - if a database access error occurs

Since:1.1.3

updateServiceOfferingXMLpublic void updateServiceOfferingXML(java.lang.String serviceXML) throws DuplicateServiceException, InvalidLicenseException, InvalidServiceException, ProcessingFailureException, java.rmi.RemoteException, java.sql.SQLException

Updates the service definition to the NetOp PM database.

Parameters:serviceXML - the XML representation for the service being updated to the NetOp PM database.

Page 93



Exceptions:DuplicateServiceException - if the name specified in the ServiceOffering object already exists in theNetOp PM systemInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services Featurecom.redback.npm.common.InvalidServiceException - if the id specified in the ServiceOfferingobject does not exist in the NetOp PM databasecom.redback.npm.common.InvalidServiceException - if the name specified in the ServiceOfferingobject is not validProcessingFailureException - if an error occurs while processing the XML documentRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

Page 94



Class ServiceSubscription

java.lang.Object | +-com.redback.npm.api.service.ServiceSubscription

public class ServiceSubscriptionextends java.lang.Object

This class provides a SOAP representation of the ServiceSubscription class.

Constructors

ServiceSubscriptionpublic ServiceSubscription()

Methods

getSubscriberAccountpublic java.lang.String getSubscriberAccount()

Returns the name of the subscriber account for this subscription.

Returns:the subscriber account name

Since:2.0

setSubscriberAccountpublic void setSubscriberAccount(java.lang.String subAcctName)

Sets the name of the subscriber account.

Parameters:subAcctName - the subscriber account name for this subscription

Since:2.0

getServiceIdpublic java.lang.String getServiceId()

Returns the service identifier for this subscription.

Returns:the service identifier

Since:2.0

Page 95

com.redback.npm.api.service.ServiceSubscription

setServiceIdpublic void setServiceId(java.lang.String serviceId)

Sets the service identifier for this subscription.

Parameters:serviceId - the service identifier for this subscription

Since:2.0

getServiceNamepublic java.lang.String getServiceName()

Returns the service name for this subscription.

Returns:the service name for this subscription

Since:2.0

setServiceNamepublic void setServiceName(java.lang.String serviceName)

System use only.

Parameters:serviceName - the service name for this subscription

Since:2.0

isActivatedpublic boolean isActivated()

Returns true if this subscription is active.

Returns:true if this subscription is active; otherwise false

Since:2.0

setActivatedpublic void setActivated(boolean activated)

System use only.

Parameters:activated - if this subscription is active

Since:2.0

Page 96


getActivationpublic java.util.Calendar getActivation()

Returns the date and time when this subscription was activated.

Returns:the subscription's activation date and time.

Since:2.0

setActivationpublic void setActivation(java.util.Calendar activation)

System use only.

Parameters:activation - the subscription's activation date and time

Since:2.0

getDeactivationpublic java.util.Calendar getDeactivation()

Returns the date and time when this subscription was deactivated.

Returns:the subscription's deactivation date and time

Since:2.0

setDeactivationpublic void setDeactivation(java.util.Calendar deactivation)

System use only.

Parameters:deactivation - the subscription's deactivation date and time

Since:2.0

getExpirationpublic java.util.Calendar getExpiration()

Returns the expiration date and time of this subscription.

Returns:the subscription's expiration date and time

Since:2.0

Page 97


setExpirationpublic void setExpiration(java.util.Calendar expiration)

System use only.

Parameters:expiration - the subscription's expiration date and time

Since:2.0

getTimeUsedpublic MeteredTime getTimeUsed()

Returns the amount of time that this subscription has been in use.

Returns:the amount of time that this subscription has been in use

Since:2.0

setTimeUsedpublic void setTimeUsed(MeteredTime timeUsed)

System use only.

Parameters:timeUsed - the amount of time that this subscription has been in use

Since:2.0

getInBytesUsedpublic long getInBytesUsed()

Returns the amount of bytes that have been uploaded while this subscription has been in use.

Returns:the amount of bytes that have been uploaded while this subscription has been in use

Since:2.0

setInBytesUsedpublic void setInBytesUsed(long inBytesUsed)

System use only.

Parameters:inBytesUsed - the amount of bytes that have been uploaded while this subscription has been in use

Since:2.0

Page 98


getOutBytesUsedpublic long getOutBytesUsed()

Returns the amount of bytes that have been downloaded while this subscription has been in use.

Returns:the amount of bytes that have been downloaded while this subscription has been in use

Since:2.0

setOutBytesUsedpublic void setOutBytesUsed(long outBytesUsed)

System use only.

Parameters:outBytesUsed - the amount of bytes that have been downloaded while this subscription has been in use

Since:2.0

isQuotaExceededpublic boolean isQuotaExceeded()

Returns true if the quota for this subscription has been exceeded.

Returns:true if this subscription has exceeded its quota; otherwise false

Since:2.0

setQuotaExceededpublic void setQuotaExceeded(boolean quotaExceeded)

System use only.

Parameters:quotaExceeded - the quota for this subscription has been exceeded

Since:2.0

getReservationStatepublic java.lang.String getReservationState()

Returns the reservation state if this subscription is a soft reservable service subscription. The valid values are: null,'Dormant' or 'Unreserved'.

Returns:the reservation state of the service subscription.

Page 99



setReservationStatepublic void setReservationState(java.lang.String reservationState)

System use only.

Parameters:reservationState - the current reservation state of the service subscription.

Since:6.1

getOverridespublic java.util.Map getOverrides()

Returns the overrides for this subscription.

Returns:a list of overrides for this subscription

Since:2.0

setOverridespublic void setOverrides(java.util.Map overrides)

Sets the overrides for this subscription.

Parameters:overrides - the subscription overrides

Since:2.0

Page 100


Package

com.redback.npm.api.session

Page 101


Class SessionIP

java.lang.Object | +-com.redback.npm.api.session.SessionIP

public class SessionIPextends java.lang.Object

This class provides a SOAP representation of the SessionIP class.

Constructors

SessionIPpublic SessionIP()

Default constructor

Methods

getSessionIdpublic java.lang.String getSessionId()

Returns the session name.

Returns:the session name

setSessionIdpublic void setSessionId(java.lang.String id)

Sets the session name.

Parameters:id - the session name to set

getIPAddresspublic java.lang.String getIPAddress()

Returns the session IP address in a CIDR format.

Returns:the IP address

setIPAddresspublic void setIPAddress(java.lang.String ip)

Sets the session IP address in a CIDR format.

Parameters:ip - the IP address

Page 102

com.redback.npm.api.session.SessionIP


Interface SessionMgmtIfc

public interface SessionMgmtIfcextends java.rmi.Remote

SessionMgmtIfc is a web services endpoint that enables you to retrieve, clear, or update subscriber sessions in the NetOp PMdatabase.

Methods

clearSubSessionByIPAddrpublic boolean clearSubSessionByIPAddr(java.lang.String ipAddr) throws InvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException, VerifyException

Clears the subscriber session associated with the specified IP address.

Parameters:ipAddr - the IP address of the session being cleared

Returns:true if the subscriber session associated with the IP address is successfully cleared; otherwise false

Exceptions:InvalidIPAddressException - if ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occursVerifyException - if there is an error communicating with the node when one or more of the followingconditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node'sconfiguration file; 3) the SNMP message failed

Since:5.0.3

clearSubSessionByNASUserNamepublic boolean clearSubSessionByNASUserName(java.lang.String nasUserName) throws InvalidNASUserException, java.rmi.RemoteException, java.sql.SQLException, VerifyException

Clear all subscriber sessions associated with the specified NAS user name.

Parameters:nasUserName - NAS username associated with the subscriber sessions being cleared

Returns:true if the subscriber sessions associated with the NAS user name are successfully cleared; otherwise false

Exceptions:InvalidNASUserException - if nasUserName is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Page 103

com.redback.npm.api.session.SessionMgmtIfc


VerifyException - if there is an error communicating with the node when one or more of the followingconditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node'sconfiguration file; 3) the SNMP message failed

Since:5.0.3

clearSubSessionBySubAcctNamepublic boolean clearSubSessionBySubAcctName(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException, VerifyException

Clears all subscriber sessions associated with the specified subscriber account name.

Parameters:subAcctName - the subscriber account name associated with the sessions being cleared

Returns:true if all subscriber sessions associated with the specified subAcctName are successfully cleared; otherwise false

Exceptions:InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occursVerifyException - if there is an error communicating with the node when one or more of the followingconditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node'sconfiguration file; 3) the SNMP message failed

Since:5.0.3

getKnownNodeNamespublic java.lang.String[] getKnownNodeNames() throws java.rmi.RemoteException, java.sql.SQLException

Returns the list of node names that are in the NetOp PM database.

Returns:an array of node names


Since:2.0

getStaticIpAddressespublic SessionIP[] getStaticIpAddresses(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of session IP addresses for the given subscriber account name.

Parameters:subAcctName - the subscriber account name whose session IP addresses you want to list

Page 104



Returns:an array of SessionIP objects


Since:2.0

getSubscriberSessionpublic SubscriberSession getSubscriberSession(java.lang.String ipAddr) throws InvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException

Returns a subscriber session for the given IP address.

Parameters:ipAddr - the IP address of the session in which you are interested

Returns:a SubscriberSession object

Exceptions:InvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

getSubscriberSessionNamespublic NameList getSubscriberSessionNames(java.lang.String nasId, java.lang.String filter) throws InvalidNASException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of subscriber session names on the given NAS that match the supplied filter string.

Parameters:nasId - the NAS identifier whose session names you want to listfilter - a filter string to use on the session names in the form of a properly escaped SQL LIKE clause; forexample, to retrieve all sessions on a node with the PPP circuit name of joe*, call the API with the filter value: joe%

Returns:a NameList object containing an array of session name strings (String objects), to a maximum of the number ofsessions allowed by the node (dependent on the SE model and SEOS version)

Exceptions:InvalidNASException - if the specified nasId is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

Page 105


getSubscriberSessionspublic SubscriberSession[] getSubscriberSessions(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of active subscriber sessions for the given subscriber account name; that is, the sessions to which thesubscriber account is currently logged in.

Parameters:subAcctName - the subscriber account name whose active sessions you want to list

Returns:an array of SubscriberSession objects


Since:2.0

getSubscriberSessionsByNASpublic SubscriberSession[] getSubscriberSessionsByNAS(java.lang.String nasId) throws InvalidNASException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of subscriber sessions for the given NAS identifier.

Parameters:nasId - the NAS identifier whose sessions you want to list

Returns:an array of SubscriberSession objects

Exceptions:InvalidNASException - if the specified nasId is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:2.0

getSubscriberSessionSummariespublic SubscriberSessionSummary[] getSubscriberSessionSummaries(java.lang.StringsubAcctName) throwsInvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of subscriber session summaries for the given subscriber account name.

Parameters:subAcctName - the subscriber account name whose session summaries you want to list

Page 106



Returns:an array of SubscriberSessionSummary objects


Since:2.0

setStaticIpAddressespublic void setStaticIpAddresses(java.lang.String subAcctName, SessionIP[] ips) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Sets a list of session IP addresses for the given subscriber account name.

Parameters:subAcctName - the subscriber account name whose sessions you are interested inips - the list of IP addresses to assign to this subscriber account


Since:2.0

Page 107


Package

com.redback.npm.api.user

Page 108


Class NASUser

java.lang.Object | +-com.redback.npm.api.user.NASUser

public class NASUserextends java.lang.Object

This class provides a SOAP representation of the NASUser class.

Constructors

NASUserpublic NASUser()

Methods

getNamepublic java.lang.String getName()

Returns the name of this NAS user.

Returns:the name of this NAS user

setNamepublic void setName(java.lang.String nasUserName)

Sets the name of this NAS User.

Parameters:nasUserName - the new name for this NAS user


Returns the name of the subscriber account associated with this NAS user.

Returns:the subscriber account name associated with this NAS user

setSubscriberAccountpublic void setSubscriberAccount(java.lang.String subAcctName)

Sets the subscriber account name to associate with this NAS user.

Parameters:subAcctName - the name of the subscriber account to associate with this NAS user

Page 109

com.redback.npm.api.user.NASUser

isLoggedInpublic boolean isLoggedIn()

Determines whether this NAS user is logged on.

Returns:true if this NAS User is logged on; otherwise false

setLoggedInpublic void setLoggedIn(boolean isLoggedIn)

Informs the system whether or not this NAS user is logged on.

Parameters:isLoggedIn - indicates whether this NAS user is logged on

getCreationDatepublic java.util.Date getCreationDate()

Returns the date and time that this NAS user record was created.

Returns:the date and time that this NAS user record was created

setCreationDatepublic void setCreationDate(java.util.Date createdOn)

System use only.

Parameters:createdOn - the date and time that this NAS user record was created

getNasIdpublic java.lang.String getNasId()

Returns the name of the node associated with this NAS user.

Returns:the node identifier associated with this NAS user

setNasIdpublic void setNasId(java.lang.String nasId)

Sets the name of the node associated with this NAS user.

Parameters:nasId - the node ID to associate with this NAS user.

getStaticIPAddressespublic java.lang.String[] getStaticIPAddresses()

Returns the array of static IP addresses for this NAS user.

Returns:

Page 110



a string array of static IP addresses; if there are no static IP addresses, an empty array is returned

setStaticIPAddressespublic void setStaticIPAddresses(java.lang.String[] ipAddresses)

Set the array of static IP addresses for this NAS user. This will overwrite any existing list of addresses.

Parameters:ipAddresses - a string array of static IP addresses for this NAS user

getFramedRoutespublic java.lang.String[] getFramedRoutes()

Returns the array of framed routes for this NAS user.

Returns:a string array of framed routes; if there are no framed routes, an empty array is returned

setFramedRoutespublic void setFramedRoutes(java.lang.String[] framedRoutes)

Set the array of framed routes for this NAS user. This will overwrite any existing list of framed routes.

Parameters:framedRoutes - a string array of framed routes for this NAS user

Page 111



Class SubscriberAccount

java.lang.Object | +-com.redback.npm.api.user.SubscriberAccount

public class SubscriberAccountextends java.lang.Object

This class provides a SOAP representation of the SubscriberAccount class.

Constructors

SubscriberAccountpublic SubscriberAccount()

Methods

getNamepublic java.lang.String getName()

Returns the name of the subscriber account.

Returns:the name of this subscriber account

Since:1.1

setNamepublic void setName(java.lang.String subAcctName)


Parameters:subAcctName - the name for this subscriber account

Since:1.1

getPasswordpublic java.lang.String getPassword()

Returns the password for this subscriber account.

Returns:the unencrypted password for this subscriber account

Since:1.1

Page 112

com.redback.npm.api.user.SubscriberAccount

setPasswordpublic void setPassword(java.lang.String subAcctPassword)

Sets the password for this subscriber account.

Parameters:subAcctPassword - the unencrypted password for this subscriber account

Since:1.1

getLocationLockpublic java.lang.String getLocationLock()

Returns the location lock for the subscriber account.

Returns:the location lock for this subscriber account

Since:5.0

setLocationLockpublic void setLocationLock(java.lang.String locationLock)


Parameters:locationLock - the location lock for this subscriber account

Since:5.0

isActivatedpublic boolean isActivated()

Returns true if this subscriber account is activated.

Returns:true if this subscriber account is activated; otherwise false

Since:1.1

setActivatedpublic void setActivated(boolean activated)

Sets whether or not this subscriber account is activated.

Parameters:activated - true if this subscriber account is activated; false if this subscriber account is not activated

Since:1.1

Page 113


getCreationDatepublic java.util.Date getCreationDate()

Returns the date and time that this subscriber account was created.

Returns:the date and time that this subscriber account was created

Since:1.1

setCreationDatepublic void setCreationDate(java.util.Date date)

System use only. Sets the creation date.

Parameters:date - the creation date

Since:1.1

getCreditControlExternalIdpublic java.lang.String getCreditControlExternalId()

Returns the credit control external ID for this subscriber account.

Returns:the credit control external ID for this subscriber account

Since:6.1.5

setCreditControlExternalIdpublic void setCreditControlExternalId(java.lang.String creditControlExternalId)

Set the credit control external ID for this subscriber account.

Parameters:creditControlExternalId - the credit control external ID for this subscriber account

Since:6.1.5

getCreditControlExternalTypepublic java.lang.String getCreditControlExternalType()

Returns the credit control external type for this subscriber account.

Returns:the credit control external type for this subscriber account

Since:6.1.5

Page 114


setCreditControlExternalTypepublic void setCreditControlExternalType(java.lang.String creditControlExternalType)

Set the credit control external type for this subscriber account.

Parameters:creditControlExternalType - the credit control external type for this subscriber account

Since:6.1.5

getExternalIdpublic java.lang.String getExternalId()

Returns the external ID for this subscriber account.

Returns:the external ID for this subscriber account

Since:6.1.2

setExternalIdpublic void setExternalId(java.lang.String externalId)

Sets the external ID for this subscriber account.

Parameters:externalId - the external Id for this subscriber account

Since:6.1.2

getExternalField1public java.lang.String getExternalField1()

Returns the value of external field 1 for this subscriber account.

Returns:the value of external field 1 for this subscriber account

Since:6.1.2

setExternalField1public void setExternalField1(java.lang.String externalFieldValue)

Sets the value of external field 1 for this subscriber account.

Parameters:externalFieldValue - the value of external field 1 for this subscriber account

Since:6.1.2

Page 115





Since:6.1.2




Since:6.1.2




Since:6.1.2




Since:6.1.2




Since:6.1.2

Page 116





Since:6.1.2




Since:6.1.2




Since:6.1.2

getSubscriptionIdspublic java.util.List getSubscriptionIds()

Returns a list of service identifiers representing the services that this subscriber account is subscribed to.

Returns:a list of service identifiers representing the subscriber account's current services

setSubscriptionIdspublic void setSubscriptionIds(java.util.List subscriptionIds)

Sets a list of service identifiers representing the services that this subscriber account is subscribed to.

Parameters:subscriptionIds - a list of service identifiers representing the subscriber account's current services

getSubscriptionspublic java.util.List getSubscriptions()

Returns a list of ServiceSubscription objects representing the services that this subscriber account is subscribed to.

Returns:

Page 117



a list of ServiceSubscription objects representing the subscriber account's current services

setSubscriptionspublic void setSubscriptions(java.util.List subscriptions)

Sets a list of ServiceSubscription objects representing the services that this subscriber account is subscribed to.

Parameters:subscriptions - list of ServiceSubscription objects representing the subscriber account's current services

isLocalpublic boolean isLocal()

Returns true if this subscriber account is managed in the NPM system.

Returns:true if the subscriber account is managed in the NPM system; false fi the subscriber account is managed in an externalsystem

Since:2.0

setLocalpublic void setLocal(boolean local)

System use only.

Parameters:local - indicates a locally managed account

Since:1.1

getCircuitAttributespublic CircuitAttribute[] getCircuitAttributes()

Returns the array of circuit attributes for this subscriber.

Returns:an array of SessionAttributeVariation objects containing circuit specific RADIUS attributes for this subscriber

Since:5.0.5

setCircuitAttributespublic void setCircuitAttributes(CircuitAttribute[] circuitAttributes)

Set this subscriber's circuit attributes.

Parameters:circuitAttributes - the array of SessionAttributeVariation objects containing circuit specific RADIUSattributes for this subscriber

Since:5.0.5

Page 118



Class SubscriberAccountNameList

java.lang.Object | +-com.redback.npm.api.user.SubscriberAccountNameList

public class SubscriberAccountNameListextends java.lang.Object

This class provides a SOAP representation of the SubscriberAccountNameList class.

Constructors

SubscriberAccountNameListpublic SubscriberAccountNameList()

Methods

getMoreNamesAvailablepublic boolean getMoreNamesAvailable()

Returns a boolean indicating if more subscriber account names are available.

Returns:true if more subscriber account names are available than the number returned for a subscriber account name search;otherwise false

getNamespublic java.lang.String[] getNames()

Returns the results, if any, from a subscriber account name search.

Returns:a String[] containing the subscriber account names that match the search

getNextCursorpublic java.lang.String getNextCursor()

Returns a string containing information relevant to the previous call. Intended to be passed as a filter parameter to theAPI and used only by the API to return the next set of subscriber account names, if any, resulting from a search to thecaller. Only valid for use when a SubscriberAccountNameList indicates that more names are available in a forwarddirection; for example, after the first API call or a subsequent call using this method to provide an API filter parameter.

Returns:a string containing API information relative to the previous call

getPrevCursorpublic java.lang.String getPrevCursor()

Page 119

com.redback.npm.api.user.SubscriberAccountNameList


Returns a string containing information relevant to the previous call. Intended to be passed as filter parameter to theAPI and used only by the API to return the previous set of subscriber account names if any, resulting from a search to thecaller. Only valid for use when a SubscriberAccountNameList has successfully traversed forward at least once using thegetNextCursor method to provide a filter parameter or when a SubscriberAccountNameList indicates that more namesare available in a backward direction after one or more subsequent API calls using this method to provide a API.


getReturnLimitpublic int getReturnLimit()

Returns an integer representing the return limit for the API server through which the search was performed. The returnlimit of an API server is the maximum number of objects that will be returned by one request or API call.

Returns:an integer value of an API server's return limit

getStatusCodepublic int getStatusCode()

Returns an integer representing the status of the subscriber account name search from the API call. Valid status codevalues and definitions for this method are: 0 - no results exist for the submitted search filter; 1 - results exist for thesubmitted search filter; 2 - results exist for the submitted search filter, but the number of names requested was larger thanthe API server's return limit; and 3 - an invalid cursor argument was submitted; for instance, when no more rows areavailable

Returns:an integer value representing the status of the subscriber account name search

setMoreNamesAvailablepublic void setMoreNamesAvailable(boolean moreNamesAvailable)

Sets a SubscriberAccountNameList's status for more names available.

Parameters:moreNamesAvailable - a boolean indicating whether or not more names are available

setNamespublic void setNames(java.lang.String[] names)

Sets a SubscriberAccountNameList's list of names.

Parameters:names - a atring array of names resulting from a subscriber account name search

setNextCursorpublic void setNextCursor(java.lang.String nextCursor)

Sets a SubscriberAccountNameList's next cursor value.

Parameters:nextCursor - a string value for the next cursor

setPrevCursorpublic void setPrevCursor(java.lang.String prevCursor)

Sets a SubscriberAccountNameList's previous cursor value.

Page 120



Parameters:prevCursor - a string value for the previous cursor

setReturnLimitpublic void setReturnLimit(int returnLimit)

Sets a SubscriberAccountNameList's API server return limit value. This value indicates the maximum number of objectsreturned by an API server in one request.

Parameters:returnLimit - an integer representing the API server return limit

setStatusCodepublic void setStatusCode(int statusCode)

Sets a SubscriberAccountNamesList's status code.

Parameters:statusCode - an integer value representing the status code resulting from a subscriber account name search

Page 121



Interface UserMgmtIfc

public interface UserMgmtIfcextends java.rmi.Remote

UserMgmtIfc is a web services endpoint that enables you to add, retrieve, update, and delete subscribers in the NetOp PMdatabase.

Methods

addNASUserpublic void addNASUser(NASUser nasUser) throws DuplicateNASUserException, InvalidNASException, InvalidNASUserException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Adds a new NAS user to the NetOp PM database. Note:The creation date of the NAS user is generated automatically bythis method. You can use the creation date variable to purge old, inactive NAS users.

Parameters:nasUser - the NASUser object that contains the details of the NAS user being added to the NetOp PM database

Exceptions:DuplicateNASUserException - if the name specified in the nasUser object already exists in the databaseInvalidNASException - if the nasId specified in the nasUser object is unknown to the NetOp PM systemInvalidNASUserException - if the name specified in the nasUser object is not validInvalidSubscriberAccountException - if the subAcctName specified in the nasUser object isunknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

addNASUserXMLpublic void addNASUserXML(java.lang.String nasUserXML) throws DuplicateNASUserException, InvalidNASException, InvalidNASUserException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Adds a new NAS user to the NetOp PM database. Note:The creation date of the NAS user is generated automatically bythis method. You can use the creation date variable to purge old, inactive NAS users.

Parameters:nasUserXML - the XML representation for the NAS users being added to the NetOp PM database.

Exceptions:DuplicateNASUserException - if the name specified in the nasUser object already exists in the databaseInvalidNASException - if the nasId specified in the nasUser object is unknown to the NetOp PM system

Page 122

com.redback.npm.api.user.UserMgmtIfc


InvalidNASUserException - if the name specified in the nasUser object is not validInvalidSubscriberAccountException - if the subAcctName specified in the nasUser object isunknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.2.4

addSubscriberAccountpublic void addSubscriberAccount(SubscriberAccount subAcct) throws DuplicateServiceSubscriptionException, DuplicateSubscriberAccountException, IncompatibleServiceException, InvalidLicenseException, InvalidNASException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException

Adds a new subscriber account to the NetOp PM database. Note:The creation date of the subscriber account isautomatically generated by this method. You can use the creation date variable to purge old, inactive subscriber accounts.

Parameters:subAcct - the SubscriberAccount object that contains the details of the subscriber account being added to theNetOp PM database

Exceptions:DuplicateServiceSubscriptionException - if the specified subAcct contains duplicated servicesDuplicateSubscriberAccountException - if the name specified in the subAcct object already existsin the NetOp PM databaseIncompatibleServiceException - if the specified serviceIds contain service identifiers that causeconflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidNASException - if the specified nasId is unknown to the NetOp PM systemInvalidServiceException - if any of the serviceIds specified in the subAcct object are unknown tothe NetOp PM systemInvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to beoverridden in the NetOp PM system or are not following a valid formatInvalidServiceSubscriptionException - if one or more of the required override attributes are missingInvalidSubscriberAccountException - if the name specified in the subAcct object is not validNoAccessServiceException - if adding the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if a service which requires a guaranteed bandwidth reservation isbeing addedSQLException - if a database access error occursTooManyServicesSelectedException - if adding the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested task

Since:1.1.3

Page 123



addSubscriberAccountXMLpublic void addSubscriberAccountXML(java.lang.String subAcctXML) throws DuplicateServiceSubscriptionException, DuplicateSubscriberAccountException, IncompatibleServiceException, InvalidLicenseException, InvalidNASException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException

Adds a new subscriber account to the NetOp PM database. Note:The creation date of the subscriber account isautomatically generated by this method. You can use the creation date variable to purge old, inactive subscriber accounts.

Parameters:subAcctXML - the XML representation for the subscriber accounts being added to the NetOp PM database.

Exceptions:DuplicateServiceSubscriptionException - if the specified subAcctXML contains duplicated servicesDuplicateSubscriberAccountException - if the name specified in the subAcct object already existsin the NetOp PM databaseIncompatibleServiceException - if the specified serviceIds contain service identifiers that causeconflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidNASException - if the specified nasId is unknown to the NetOp PM systemcom.redback.npm.common.InvalidServiceException - if any of the serviceIds specified in thesubAcct object are unknown to the NetOp PM systemInvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to beoverridden in the NetOp PM system or are not following a valid formatInvalidServiceSubscriptionException - if one or more of the required override attributes are missingInvalidSubscriberAccountException - if the name specified in the subAcct object is not validNoAccessServiceException - if adding the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if a service which requires a guaranteed bandwidth reservation isbeing addedSQLException - if a database access error occursTooManyServicesSelectedException - if adding the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested task

Since:1.2.4

getNASUserpublic NASUser getNASUser(java.lang.String nasUserName) throws InvalidNASUserException, java.rmi.RemoteException, java.sql.SQLException

Returns the details of the specified NAS user from the NetOp PM database.

Parameters:nasUserName - the name of the NAS user for which to return details

Returns:

Page 124



a NASUser object that contains the details of the NAS user associated with the specified nasUserName

Exceptions:InvalidNASUserException - if nasUserName is unknown to the NetOp PM systemInvalidNASUserException - if the specified nasUserName is not validRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

getNASUserspublic NASUser[] getNASUsers(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns a list of NASUser objects associated with the specified subscriber account.

Parameters:subAcctName - the name of the subscriber account used to retrieve the NASUser objects associated with thissubscriber account

Returns:an array ofNASUser objects associated with the specified subAcctName. If there are noNASUser objects associatedwith the subAcctName, an empty array is returned.

Exceptions:InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM systemInvalidSubscriberAccountException - if the specified subAcctName is not validRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

getNASUsersXMLpublic java.lang.String getNASUsersXML(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns a list ofNASUser objects associated with the specified subscriber account.

Parameters:subAcctName - the name of the subscriber account used to retrieve the NASUser objects associated with thissubscriber account

Returns:an XML representation for theNASUser objects associated with the specified subAcctName

Exceptions:InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM systemInvalidSubscriberAccountException - if the specified subAcctName is not validRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.2.4

Page 125


getNASUserXMLpublic java.lang.String getNASUserXML(java.lang.String nasUserName) throws InvalidNASUserException, java.rmi.RemoteException, java.sql.SQLException

Returns the details of the specified NAS user from the NetOp PM database.

Parameters:nasUserName - the name of the NAS user for which to return details

Returns:an XML representation for the NAS user specified by the nasUserName.

Exceptions:InvalidNASUserException - if nasUserName is unknown to the NetOp PM systemInvalidNASUserException - if the specified nasUserName is not validRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.2.4

getSubAcctNamepublic java.lang.String getSubAcctName(java.lang.String ipAddr) throws InvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException

Returns the subscriber account name associated with the specified IP address from the NetOp PM database.


Returns:the subscriber's account name

Exceptions:InvalidIPAddressException - if ipAddr does not have an associated subscriber accountRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.2.4.1

getSubscriberAccountpublic SubscriberAccount getSubscriberAccount(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns the details of the specified subscriber account from the NetOp PM database.

Parameters:subAcctName - the name of the subscriber account for which to return details

Returns:

Page 126



a SubscriberAccount object that contains the details of the subscriber account associated with the specifiedsubAcctName

Exceptions:InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PMsystemInvalidSubscriberAccountException - if the specified subAcctName is not validRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

getSubscriberAccountNameListpublic SubscriberAccountNameList getSubscriberAccountNameList(java.lang.String filter, int numRows) throwsjava.rmi.RemoteException, java.sql.SQLException

Returns a SubscriberAccountNameList populated with a list of subscriber account names resulting from a subscriberaccount name search. It uses the filter and numRows parameters to return a specified portion of a subscriber accountname search. The number of names returned is less than or equal to the numRows parameter, but never exceeds the returnlimit of the API server where it is invoked. This method also supports the use of a SubscriberAccountNameList'sgetNextCursor() and getPrevCursor() methods to supply a filter argument to support forward and backwardtraversal of a subscriber account name search result if more than the number of names returned are available. The returnlimit of an API server is the maximum number of objects that can be returned by an API server in one call. If numRows ismore than an API server's return limit or less than 0, this method will return a number of names less than or equal to thereturn limit. If numRows has a value of 0, no names will be returned, but a search will be performed and an appropriatestatus code will be set.

Parameters:filter - the search filter for the subscriber account names supporting wildcards '*' to match any number ofcharacters, and '?' or '.' to match a single character. To search for any of the special characters, (such as *?\.), enter abackslash (\) before the character. Also accepts valid return values from the SubscriberAccountNameListgetNextCursor() and getPrevCursor() methodsnumRows - the maximum number of subscriber account names to be returned

Returns:a SubscriberAccountNameList of subscriber account names


See Also:com.redback.npm.common.SubscriberAccountNameList

Since:6.0.3.2

getSubscriberAccountNamespublic NameList getSubscriberAccountNames(java.lang.String filter) throws java.rmi.RemoteException, ReturnLimitExceededException, java.sql.SQLException

Returns a NameList of subscriber account names.

Parameters:

Page 127



filter - the search filter for the subscriber account names supporting wildcards '*' to match any number ofcharacters and '?' or '.' to match a single character. To search for any of the special characters(such as *?\.) enter abackslash (\) before the character.

Returns:a NameList of subscriber account names

Exceptions:RemoteException - if an unexpected error occursReturnLimitExceededException - if the number of matching rows exceeds the configured maximumreturn limitSQLException - if a database access error occurs

Since:2.0

getSubscriberAccountNamesByExternalIdpublic java.lang.String[] getSubscriberAccountNamesByExternalId(java.lang.StringexternalId) throwsjava.rmi.RemoteException, java.sql.SQLException

Returns an array of subscriber account names for subscriber accounts that contain the external ID provided. The maximumnumber of names that will be returned is 20. If there are more than 20 subscriber accounts that meet this criterion, the first20 will be returned. If no subscribers are found, an empty String array is returned.

Parameters:externalId - the external ID to search by

Returns:an array of subscriber account names


Since:6.1.2

getSubscriberAccountXMLpublic java.lang.String getSubscriberAccountXML(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Returns the details of the specified subscriber account from the NetOp PM database.

Parameters:subAcctName - the name of the subscriber account for which to return details

Returns:an XML representation for the subscriber account associated with the specified subAcctName

Exceptions:InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PMsystemInvalidSubscriberAccountException - if the specified subAcctName is not validRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Page 128



Since:1.2.4

removeNASUserpublic void removeNASUser(java.lang.String nasUserName) throws ActiveSubSessionException, InvalidNASUserException, java.rmi.RemoteException, java.sql.SQLException

Removes a NAS user from the NetOp PM database.

Parameters:nasUserName - the name of the NAS user to be removed from the NetOp PM database

Exceptions:ActiveSubSessionException - if one or more sessions exist for the specified nasUserNameInvalidNASUserException - if nasUserName is unknown to the NetOp PM systemInvalidNASUserException - if the specified nasUserName is not validRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

removeSubscriberAccountpublic void removeSubscriberAccount(java.lang.String subAcctName) throws ActiveSubSessionException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Removes a subscriber account from the NetOp PM database.

Parameters:subAcctName - the name of the subscriber account to be removed from the NetOp PM database

Exceptions:ActiveSubSessionException - if one or more sessions exist for the specified subAcctNameInvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM systemInvalidSubscriberAccountException - if the specified subAcctName is not validRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

setDefaultISPByNASUserpublic void setDefaultISPByNASUser(java.lang.String nasUserName, java.lang.String realm) throws InvalidNASUserException, java.rmi.RemoteException, java.sql.SQLException

Sets the default ISP for the NAS user name in the NetOp PM database. The following is performed by this method: (1)Clears the subscriber account name associated with the NAS user name. (2) Sets the logged in flag to 'N' for the NAS username. (3) Sets the default realm for the NAS user name.

Parameters:nasUserName - the NAS user name for which to set this default realm

Page 129



realm - the default realm to set for this NAS user name

Exceptions:InvalidNASUserException - if the name specified in the nasUser object is unknown to the NetOp PMsystemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

setDefaultISPBySubSessionpublic void setDefaultISPBySubSession(java.lang.String ipAddr, java.lang.String realm) throws InvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException

Sets the default ISP for the subscriber session in the NetOp PM database. The following is performed by this method: (1)Clears the subscriber account name associated with the session. (2) Sets the logged in flag to 'N' for the session. (3) Sets thedefault realm for the session.

Parameters:ipAddr - the IP address of the PC on which to set this default realmrealm - the default realm to set for this IP address

Exceptions:InvalidIPAddressException - if the ipAddr is unknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

updateNASUserpublic void updateNASUser(NASUser nasUser) throws InvalidNASException, InvalidNASUserException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Modifies the details of the specified NAS user in the NetOp PM database.

Parameters:nasUser - the NASUser object that contains the details of the NAS user being modified in the NetOp PMdatabase

Exceptions:InvalidNASException - if the nasId specified in the nasUser object is unknown to NetOp PM systemInvalidNASUserException - if the name specified in nasUser object is unknown to the NetOp PM systemInvalidNASUserException - if the name specified in the nasUser object is not validInvalidSubscriberAccountException - if the subAcctNamespecified in the nasUser object isunknown to NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.1.3

Page 130



updateNASUserXMLpublic void updateNASUserXML(java.lang.String nasUserXML) throws InvalidNASException, InvalidNASUserException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException

Modifies the details of the specified NAS user's XML representation in the NetOp PM database.

Parameters:nasUserXML - the XML representation for the NAS users being modified in the NetOp PM database.

Exceptions:InvalidNASException - if the nasId specified in the nasUser object is unknown to NetOp PM systemInvalidNASUserException - if the name specified in nasUser object is unknown to the NetOp PM SystemInvalidNASUserException - if the name specified in the nasUser object is not validInvalidSubscriberAccountException - if the subAcctName specified in the nasUser object isunknown to the NetOp PM systemRemoteException - if an unexpected error occursSQLException - if a database access error occurs

Since:1.2.4

updateSubscriberAccountpublic void updateSubscriberAccount(SubscriberAccount subAcct) throws DuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidLicenseException, InvalidNASException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException

Modifies the details of the specified subscriber account in the NetOp PM database.

Parameters:subAcct - the SubscriberAccount object that contains the details of the subscriber account being modified inthe NetOp PM database.

Exceptions:DuplicateServiceSubscriptionException - if the specified subAcct contains duplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service identifier that causesconflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidNASException - if the specified nasId is unknown to the NetOp PM systemInvalidServiceException - if any service specified in the subAcct object is unknown to the NetOp PMsystemInvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to beoverridden in the NetOp PM system or are not following a valid formatInvalidServiceSubscriptionException - if one or more of the required override attributes are missingInvalidSubscriberAccountException - if the name specified in the subAcct object is unknown to theNetOp PM systemInvalidSubscriberAccountException - if the name specified in the subAcct object is not valid

Page 131



NoAccessServiceException - if updating the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if a service which requires a guaranteed bandwidth reservation isbeing addedSessionLimitException - if the specified services allow fewer sessions than the subscriber has currentlylogged in and if the current services are not defined to log off the old sessions automaticallySQLException - if a database access error occursTooManyServicesSelectedException - if updating the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested task

Since:1.1.3

updateSubscriberAccountXMLpublic void updateSubscriberAccountXML(java.lang.String subAcctXML) throws DuplicateServiceSubscriptionException, IncompatibleServiceException, InvalidLicenseException, InvalidNASException, InvalidServiceException, InvalidServiceSubscriptionException, InvalidSubscriberAccountException, NoAccessServiceException, java.rmi.RemoteException, ResourceRequestDeniedException, SessionLimitException, java.sql.SQLException, TooManyServicesSelectedException, UnauthorizedException

Modifies the details of the specified subscriber account's XML representation in the NetOp PM database.

Parameters:subAcctXML - the XML representation for the subscriber accounts being updated in the NetOp PM database.

Exceptions:DuplicateServiceSubscriptionException - if the specified subAcctXML contains duplicated servicesIncompatibleServiceException - if the specified serviceIds contain a service identifier that causesconflictsInvalidLicenseException - if not licensed for Admission Control FunctionInvalidLicenseException - if not licensed for Complex Services FeatureInvalidNASException - if the specified nasId is unknown to the NetOp PM systemInvalidServiceException - if any service specified in the subAcct object is unknown to the NetOp PMsystemInvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to beoverridden in the NetOp PM system or are not following a valid formatInvalidServiceSubscriptionException - if one or more of the required override attributes are missingInvalidSubscriberAccountException - if the name specified in the subAcct object is unknown to theNetOp PM systemInvalidSubscriberAccountException - if the name specified in the subAcct object is not validNoAccessServiceException - if updating the specified serviceIds would leave the subscriber with noaccess serviceRemoteException - if an unexpected error occursResourceRequestDeniedException - if a service which requires a guaranteed bandwidth reservation isbeing addedSessionLimitException - if the specified services allow fewer sessions than the subscriber has currentlylogged in and if the current services are not defined to log off the old sessions automaticallySQLException - if a database access error occursTooManyServicesSelectedException - if updating the specified serviceIds would select too manyservicesUnauthorizedException - if the API user is not authorized to perform the requested task

Since:

Page 132



1.2.4

Page 133


Package

com.redback.npm.common

Page 134


Class ActiveSubSessionException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.ActiveSubSessionException

public class ActiveSubSessionExceptionextends java.lang.Exception

This exception represents an error if an attempt was made to remove a subscriber account or a NAS user with active sessions in theNetOp PM database.

Constructors

ActiveSubSessionExceptionpublic ActiveSubSessionException()

ActiveSubSessionExceptionpublic ActiveSubSessionException(java.lang.String message)

Parameters:message - a detailed error message

Page 135

com.redback.npm.common.ActiveSubSessionException


Class AuthenticationReply

java.lang.Object | +-com.redback.npm.common.AuthenticationReply

public class AuthenticationReplyextends java.lang.Object

AuthenticationReply contains any Reply-Messages from the RADIUS server and a boolean to indicate whether the user has beenauthenticated.

Constructors

AuthenticationReplypublic AuthenticationReply()

AuthenticationReplypublic AuthenticationReply(boolean value)

Parameters:value - indicates whether the user has been authenticated

AuthenticationReplypublic AuthenticationReply(boolean value, java.lang.String message)

Parameters:value - indicates whether the user has been authenticatedmessage - the reply messages from the RADIUS server

Methods

setAuthenticatedpublic void setAuthenticated(boolean value)

Sets whether the user has been authenticated.

Parameters:value - indicates whether the user has been authenticated

getAuthenticatedpublic boolean getAuthenticated()

Returns whether the user has been authenticated.

Page 136

com.redback.npm.common.AuthenticationReply


Returns:true if the user has been authenticated; otherwise false

getReplypublic java.lang.String getReply()

Returns the reply messages from the RADIUS server.

Returns:the reply messages from the RADIUS server

setReplypublic void setReply(java.lang.String message)

Sets the reply messages from the RADIUS server.

Parameters:message - the reply messages from the RADIUS server to set

Page 137

com.redback.npm.common.AuthenticationReply


Class DuplicateNASException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.DuplicateNASException

public class DuplicateNASExceptionextends java.lang.Exception

This exception represents an error when a NAS being added contains a name that already exists in the NetOp PM system.

Constructors

DuplicateNASExceptionpublic DuplicateNASException()

DuplicateNASExceptionpublic DuplicateNASException(java.lang.String message)


DuplicateNASExceptionpublic DuplicateNASException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - a detailed error messagecause - the throwable cause of the error

DuplicateNASExceptionpublic DuplicateNASException(java.lang.Throwable cause)

Parameters:cause - the throwable cause of the error

Page 138

com.redback.npm.common.DuplicateNASException


Class DuplicateNASUserException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.DuplicateNASUserException

public class DuplicateNASUserExceptionextends java.lang.Exception

This exception represents an error when a NAS user being added contains a name that already exists in the NetOp PM system.

Constructors

DuplicateNASUserExceptionpublic DuplicateNASUserException()

DuplicateNASUserExceptionpublic DuplicateNASUserException(java.lang.String message)


DuplicateNASUserExceptionpublic DuplicateNASUserException(java.lang.String message, java.lang.Throwable cause)


DuplicateNASUserExceptionpublic DuplicateNASUserException(java.lang.Throwable cause)


Page 139

com.redback.npm.common.DuplicateNASUserException


Class DuplicateProxyInfoException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.DuplicateProxyInfoException

public class DuplicateProxyInfoExceptionextends java.lang.Exception

This exception represents an error when a proxy info being added contains a realm that already exists in the NetOp PM System.

Constructors

DuplicateProxyInfoExceptionpublic DuplicateProxyInfoException()

DuplicateProxyInfoExceptionpublic DuplicateProxyInfoException(java.lang.String message)


DuplicateProxyInfoExceptionpublic DuplicateProxyInfoException(java.lang.String message, java.lang.Throwable cause)


DuplicateProxyInfoExceptionpublic DuplicateProxyInfoException(java.lang.Throwable cause)


Page 140

com.redback.npm.common.DuplicateProxyInfoException


Class DuplicateServiceException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.DuplicateServiceException

public class DuplicateServiceExceptionextends java.lang.Exception

This exception represents an error when a service offering being added contains a service identifier or name that already exists inthe NetOp PM system.

Constructors

DuplicateServiceExceptionpublic DuplicateServiceException()

DuplicateServiceExceptionpublic DuplicateServiceException(java.lang.String message)


DuplicateServiceExceptionpublic DuplicateServiceException(java.lang.String message, java.lang.Throwable cause)


DuplicateServiceExceptionpublic DuplicateServiceException(java.lang.Throwable cause)


Page 141

com.redback.npm.common.DuplicateServiceException


Class DuplicateServiceSubscriptionException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.DuplicateServiceSubscriptionException

public class DuplicateServiceSubscriptionExceptionextends java.lang.Exception

This exception represents an error when a service subscription that is being added to a subscriber account already exists in thesubscriber account's list of service subscriptions.

Constructors

DuplicateServiceSubscriptionExceptionpublic DuplicateServiceSubscriptionException()

DuplicateServiceSubscriptionExceptionpublic DuplicateServiceSubscriptionException(java.lang.String message)


Page 142

com.redback.npm.common.DuplicateServiceSubscriptionException


Class DuplicateSubscriberAccountException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.DuplicateSubscriberAccountException

public class DuplicateSubscriberAccountExceptionextends java.lang.Exception

This exception represents an error when a subscriber account being added contains a name that already exists in the NetOp PMsystem.

Constructors

DuplicateSubscriberAccountExceptionpublic DuplicateSubscriberAccountException()

DuplicateSubscriberAccountExceptionpublic DuplicateSubscriberAccountException(java.lang.String message)


Page 143

com.redback.npm.common.DuplicateSubscriberAccountException


Class IncompatibleServiceException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.IncompatibleServiceException

public class IncompatibleServiceExceptionextends java.lang.Exception

This exception represents an error when a selected service causes conflict with a subscriber account's list of existing servicesubscriptions.

Constructors

IncompatibleServiceExceptionpublic IncompatibleServiceException()

IncompatibleServiceExceptionpublic IncompatibleServiceException(java.lang.String message)


Page 144

com.redback.npm.common.IncompatibleServiceException


Class InvalidIPAddressException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidIPAddressException

public class InvalidIPAddressExceptionextends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize the IP address associated with thissubscriber's PC.

Constructors

InvalidIPAddressExceptionpublic InvalidIPAddressException()

InvalidIPAddressExceptionpublic InvalidIPAddressException(java.lang.String message)


InvalidIPAddressExceptionpublic InvalidIPAddressException(java.lang.String message, java.lang.Throwable cause)


InvalidIPAddressExceptionpublic InvalidIPAddressException(java.lang.Throwable cause)


Page 145

com.redback.npm.common.InvalidIPAddressException


Class InvalidNASException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidNASException

public class InvalidNASExceptionextends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this NAS.

Constructors

InvalidNASExceptionpublic InvalidNASException()

InvalidNASExceptionpublic InvalidNASException(java.lang.String message)


InvalidNASExceptionpublic InvalidNASException(java.lang.String message, java.lang.Throwable cause)


InvalidNASExceptionpublic InvalidNASException(java.lang.Throwable cause)


Page 146

com.redback.npm.common.InvalidNASException


Class InvalidNASUserException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidNASUserException

public class InvalidNASUserExceptionextends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this NAS user.

Constructors

InvalidNASUserExceptionpublic InvalidNASUserException()

InvalidNASUserExceptionpublic InvalidNASUserException(java.lang.String message)


InvalidNASUserExceptionpublic InvalidNASUserException(java.lang.String message, java.lang.Throwable cause)


InvalidNASUserExceptionpublic InvalidNASUserException(java.lang.Throwable cause)


Page 147

com.redback.npm.common.InvalidNASUserException


Class InvalidProxyInfoException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidProxyInfoException

public class InvalidProxyInfoExceptionextends java.lang.Exception

This exception represents an error due to NPM being unable to recognize the configuration.

Constructors

InvalidProxyInfoExceptionpublic InvalidProxyInfoException()

InvalidProxyInfoExceptionpublic InvalidProxyInfoException(java.lang.String message)


InvalidProxyInfoExceptionpublic InvalidProxyInfoException(java.lang.String message, java.lang.Throwable cause)


InvalidProxyInfoExceptionpublic InvalidProxyInfoException(java.lang.Throwable cause)


Page 148

com.redback.npm.common.InvalidProxyInfoException


Class InvalidServiceException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidServiceException

public class InvalidServiceExceptionextends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this service.

Constructors

InvalidServiceExceptionpublic InvalidServiceException()

InvalidServiceExceptionpublic InvalidServiceException(java.lang.String message)


InvalidServiceExceptionpublic InvalidServiceException(java.lang.String message, java.lang.Throwable cause)


InvalidServiceExceptionpublic InvalidServiceException(java.lang.Throwable cause)


Page 149

com.redback.npm.common.InvalidServiceException


Class InvalidServiceSubscriptionException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidServiceSubscriptionException

public class InvalidServiceSubscriptionExceptionextends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this service to which this subscriber hassubscribed.

Constructors

InvalidServiceSubscriptionExceptionpublic InvalidServiceSubscriptionException()

InvalidServiceSubscriptionExceptionpublic InvalidServiceSubscriptionException(java.lang.String message)


Page 150

com.redback.npm.common.InvalidServiceSubscriptionException


Class InvalidSubscriberAccountException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidSubscriberAccountException

public class InvalidSubscriberAccountExceptionextends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this subscriber account.

Constructors

InvalidSubscriberAccountExceptionpublic InvalidSubscriberAccountException()

InvalidSubscriberAccountExceptionpublic InvalidSubscriberAccountException(java.lang.String message)


InvalidSubscriberAccountExceptionpublic InvalidSubscriberAccountException(java.lang.String message, java.lang.Throwable cause)


InvalidSubscriberAccountExceptionpublic InvalidSubscriberAccountException(java.lang.Throwable cause)


Page 151

com.redback.npm.common.InvalidSubscriberAccountException


Class MeteredTime

java.lang.Object | +-com.redback.npm.common.MeteredTime

public class MeteredTimeextends java.lang.Objectimplements java.lang.Cloneable

The MeteredTime class holds the amount of time used in a metered time service subscription.

All Implemented interfaces:java.lang.Cloneable

Constructors

MeteredTimepublic MeteredTime()

This constructor is required by our SOAP web services toolkit. It is not intended to be called by our domain code.

MeteredTimepublic MeteredTime(int d, int h, int m, int s)

Parameters:d - the number of daysh - the number of hoursm - the number of minutess - the number of seconds

Exceptions:IllegalArgumentException - if a parameter fails validation

Methods

subtractpublic static MeteredTime subtract(MeteredTime i1, MeteredTime i2)

Returns the difference between two MeteredTime objects

Parameters:i1 - the MeteredTime object to be subtracted fromi2 - the MeteredTime object to subtract

Returns:

Page 152

com.redback.npm.common.MeteredTime


a MeteredTime object containing the difference

clonepublic java.lang.Object clone() throws java.lang.CloneNotSupportedException

Creates and returns a copy of this object.

Returns:a clone of this instance.

Exceptions:CloneNotSupportedException - if the object's class does not support the Cloneableinterface. Subclassesthat override the clonemethod can also throw this exception to indicate that an instance cannot be cloned.

See Also:Cloneable

getDayspublic int getDays()

Returns the number of days.

Returns:the number of days

setDayspublic void setDays(int d)

Sets the number of days.

Parameters:d - the number of days

getHourspublic int getHours()

Returns the number of hours.

Returns:the number of hours

setHourspublic void setHours(int h) throws java.lang.IllegalArgumentException

Sets the number of hours.

Parameters:h - the number of hours

Exceptions:IllegalArgumentException - if the number of hours are not in the range of 0 to 23

Page 153



getMinutespublic int getMinutes()

Returns the number of minutes.

Returns:the number of minutes

setMinutespublic void setMinutes(int m) throws java.lang.IllegalArgumentException

Sets the number of minutes.

Parameters:m - the number of minutes

Exceptions:IllegalArgumentException - if the number of minutes are not in the range of 0 to 60

getSecondspublic int getSeconds()

Returns the number of seconds.

Returns:the number of seconds

setSecondspublic void setSeconds(int s) throws java.lang.IllegalArgumentException

Sets the number of seconds.

Parameters:s - the number of seconds

Exceptions:IllegalArgumentException - if the number of seconds are not in the range of 0 to 60

getTimeStringpublic java.lang.String getTimeString()

Returns the time in a string format.

Returns:the time in a string format

setTimeStringpublic void setTimeString(java.lang.String time)

Unsupported Operation.

Parameters:time - the time in string format; you cannot set this--it is internal only

Page 154


toStringpublic java.lang.String toString()

Returns the time in a string format.

Returns:the time in a string format

getTotalSecondspublic long getTotalSeconds()

Converts and returns the total time in seconds.

Returns:the total time in seconds

Page 155



Class MeteredTimeUsage

java.lang.Object | +-com.redback.npm.common.MeteredUsage | +-com.redback.npm.common.MeteredTimeUsage

public class MeteredTimeUsageextends MeteredUsage

The MeteredTimeUsage class holds the usage of a metered time service subscription.

Constructors

MeteredTimeUsagepublic MeteredTimeUsage()


MeteredTimeUsagepublic MeteredTimeUsage(ServiceSubscription subscription)

Parameters:subscription - the ServiceSubscription object

Methods

getTimeUsedpublic MeteredTime getTimeUsed()

Returns the amount of time used.

Returns:the amount of time used

setTimeUsedpublic void setTimeUsed(MeteredTime used)

Sets the amount of time used.

Parameters:used - the amount of time used

getTimeLimitpublic MeteredTime getTimeLimit()

Returns the time limit.

Returns:

Page 156

com.redback.npm.common.MeteredTimeUsage


the time limit

setTimeLimitpublic void setTimeLimit(MeteredTime limit)

Sets the time limit.

Parameters:limit - the time limit

getTimeRemainingpublic MeteredTime getTimeRemaining()

Returns the time remaining before the time limit is reached.

Returns:the time remaining

setTimeRemainingpublic void setTimeRemaining(MeteredTime remaining)


Parameters:remaining - the amount of time remaining; you cannot set the time as it is done internally

Page 157

com.redback.npm.common.MeteredTimeUsage


Class MeteredUsage

java.lang.Object | +-com.redback.npm.common.MeteredUsage

public abstract class MeteredUsageextends java.lang.Object

The MeteredUsage class holds the usage of a metered service subscription.

Direct Known Subclasses:MeteredVolumeUsage, MeteredTimeUsage

Constructors

MeteredUsagepublic MeteredUsage()


MeteredUsagepublic MeteredUsage(ServiceSubscription subscription)


Methods


Returns the service identifier.


setServiceIdpublic void setServiceId(java.lang.String id)


Parameters:id - the service identifier; you cannot set this as it is done internally


Gets the service name.

Page 158

com.redback.npm.common.MeteredUsage


Returns:the service name

setServiceNamepublic void setServiceName(java.lang.String name)


Parameters:name - the service name; you cannot set this as it is done internally

Page 159

com.redback.npm.common.MeteredUsage


Class MeteredVolumeUsage

java.lang.Object | +-com.redback.npm.common.MeteredUsage | +-com.redback.npm.common.MeteredVolumeUsage

public class MeteredVolumeUsageextends MeteredUsage

The MeteredVolumeUsage class holds the usage of a metered volume service subscription.

Constructors

MeteredVolumeUsagepublic MeteredVolumeUsage()


MeteredVolumeUsagepublic MeteredVolumeUsage(long inBytesRemaining, long outBytesRemaining)

Constructor

Parameters:inBytesRemaining - In bytes remainingoutBytesRemaining - Out bytes remaining

MeteredVolumeUsagepublic MeteredVolumeUsage(ServiceSubscription subscription)


Methods

getInBytesUsedpublic long getInBytesUsed()

Returns the number of bytes uploaded.

Returns:the number of bytes uploaded

setInBytesUsedpublic void setInBytesUsed(long used)

Sets the number of bytes uploaded.

Page 160

com.redback.npm.common.MeteredVolumeUsage


Parameters:used - the number of bytes uploaded

getInBytesLimitpublic long getInBytesLimit()

Returns the upload limit.

Returns:the upload limit

setInBytesLimitpublic void setInBytesLimit(long limit)

Sets the upload limit.

Parameters:limit - the upload limit

getInBytesRemainingpublic long getInBytesRemaining()

Returns the number of upload bytes remaining before the quota is exceeded.

Returns:the number of upload bytes remaining

getInKiloBytesRemainingpublic long getInKiloBytesRemaining()

Returns the number of upload kilobytes remaining before the quota is exceeded.

Returns:the number of upload kilobytes remaining

setInBytesRemainingpublic void setInBytesRemaining(long remaining)

Unsupported operation.

Parameters:remaining - the number of upload bytes remaining; you cannot set this as it is done internally

getOutBytesUsedpublic long getOutBytesUsed()

Returns the number of bytes downloaded.

Returns:the number of bytes downloaded

setOutBytesUsedpublic void setOutBytesUsed(long used)

Page 161



Sets the number of bytes downloaded.

Parameters:used - the number of bytes downloaded

getOutBytesLimitpublic long getOutBytesLimit()

Returns the download limit.

Returns:the download limit

setOutBytesLimitpublic void setOutBytesLimit(long limit)

Sets the download limit.

Parameters:limit - the download limit

getOutBytesRemainingpublic long getOutBytesRemaining()

Returns the number of download bytes remaining before the quota is exceeded.

Returns:the number of download bytes remaining

getOutKiloBytesRemainingpublic long getOutKiloBytesRemaining()

Returns the number of download kilobytes remaining before the quota is exceeded.

Returns:the number of download kilobytes remaining

setOutBytesRemainingpublic void setOutBytesRemaining(long remaining)

Unsupported operation.

Parameters:remaining - the number of download bytes remaining; you cannot set this as it is done internally

Page 162



Class NameList

java.lang.Object | +-com.redback.npm.common.NameList

public class NameListextends java.lang.Object

This class holds a list of names returned from an API method. It also has a number indicating the total number of items that couldhave been returned. That number may be greater than the number of items in the list if the configurable maximum was reached.

Constructors

NameListpublic NameList()

NameListpublic NameList(java.lang.String[] nameList, int count)

Parameters:nameList - an array of the namescount - the total number of names that could be retrieved

Methods

getNumFoundpublic int getNumFound()

Returns the number of items that satisfied the request that created this NameList. This value may be greater than thenumber of items returned in the list.

Returns:the number of items that satisfied the request

setNumFoundpublic void setNumFound(int found)

Sets the number of items that satisfied the request that created this NameList. This value may be greater than the number ofitems returned in the list.

Parameters:found - the number of items that satisfied the request

Page 163

com.redback.npm.common.NameList


getNameListpublic java.lang.String[] getNameList()

Returns the list of names.

Returns:an array of the names

setNameListpublic void setNameList(java.lang.String[] nameList)

Sets the list of names. This new list replaces any existing list.

Parameters:nameList - an array of names

equalspublic boolean equals(java.lang.Object o)

hashCodepublic int hashCode()

Page 164

com.redback.npm.common.NameList


Class NASInUseException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.NASInUseException

public class NASInUseExceptionextends java.lang.Exception

This exception represents an error due to an attempt that was made to remove a NAS which is still being used in the NetOp PMsystem.

Constructors

NASInUseExceptionpublic NASInUseException()

NASInUseExceptionpublic NASInUseException(java.lang.String message)


NASInUseExceptionpublic NASInUseException(java.lang.String message, java.lang.Throwable cause)


NASInUseExceptionpublic NASInUseException(java.lang.Throwable cause)


Page 165

com.redback.npm.common.NASInUseException


Class NoAccessServiceException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.NoAccessServiceException

public class NoAccessServiceExceptionextends java.lang.Exception

This exception represents an error when the subscriber has no access service subscribed.

Constructors

NoAccessServiceExceptionpublic NoAccessServiceException()

NoAccessServiceExceptionpublic NoAccessServiceException(java.lang.String message)


Page 166

com.redback.npm.common.NoAccessServiceException


Class ProcessingFailureException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.ProcessingFailureException

public class ProcessingFailureExceptionextends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize the service.

Constructors

ProcessingFailureExceptionpublic ProcessingFailureException()

ProcessingFailureExceptionpublic ProcessingFailureException(java.lang.String message)


ProcessingFailureExceptionpublic ProcessingFailureException(java.lang.String message, java.lang.Throwable cause)


ProcessingFailureExceptionpublic ProcessingFailureException(java.lang.Throwable cause)


Page 167

com.redback.npm.common.ProcessingFailureException


Class ReturnLimitExceededException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.ReturnLimitExceededException

public class ReturnLimitExceededExceptionextends java.lang.Exception

This exception represents an error when the number of matching rows for a query exceeds the configured maximum return limit.

Constructors

ReturnLimitExceededExceptionpublic ReturnLimitExceededException()

ReturnLimitExceededExceptionpublic ReturnLimitExceededException(java.lang.String message)


ReturnLimitExceededExceptionpublic ReturnLimitExceededException(java.lang.String message, java.lang.Throwable cause)


ReturnLimitExceededExceptionpublic ReturnLimitExceededException(java.lang.Throwable cause)


Page 168

com.redback.npm.common.ReturnLimitExceededException


Class ServiceInUseException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.ServiceInUseException

public class ServiceInUseExceptionextends java.lang.Exception

This exception represents an error due to an attempt to remove a service offering which is still being used in the NetOp PM system.

Constructors

ServiceInUseExceptionpublic ServiceInUseException()

ServiceInUseExceptionpublic ServiceInUseException(java.lang.String message)


ServiceInUseExceptionpublic ServiceInUseException(java.lang.String message, java.lang.Throwable cause)


ServiceInUseExceptionpublic ServiceInUseException(java.lang.Throwable cause)


Page 169

com.redback.npm.common.ServiceInUseException


Class ServiceListEntry

java.lang.Object | +-com.redback.npm.common.ServiceListEntry

public class ServiceListEntryextends java.lang.Object

This class wraps a service offering and represents an entry in the service list.

Constructors

ServiceListEntrypublic ServiceListEntry()


ServiceListEntrypublic ServiceListEntry(ServiceOffering offering)

Parameters:offering - the ServiceOffering object

ServiceListEntrypublic ServiceListEntry(ServiceSubscription subscription)


Methods


Returns the service identifier associated with this service.

Returns:the service identifier for this service

Since:1.1

setServiceIdpublic void setServiceId(java.lang.String serviceId)

Page 170

com.redback.npm.common.ServiceListEntry


This method is implemented solely for the purpose of generating the proper web services definition for this object. Itshould never be called.

Parameters:serviceId - the service identifier for this service

Since:1.1


Returns the name of this service.

Returns:the name of this service

Since:1.1

getOfferingpublic ServiceOffering getOffering()

Returns the service offering for this service.

Returns:the ServiceOffering object

Since:5.0

setServiceNamepublic void setServiceName(java.lang.String serviceName)

This method is implemented solely for the purpose of generating the proper web services definition for this object. Itshould never be called.

Parameters:serviceName - the name of this service

Since:1.1

equalspublic boolean equals(java.lang.Object o)

Returns true if the provided ServiceListEntry contains the same service as this ServiceListEntry.

Parameters:o - the ServiceListEntry object to compare

Returns:true if the provided object is an instance of the ServiceListEntry class and has the same service identifier as this one;otherwise false

Page 171



hashCodepublic int hashCode()

Returns a hash code value for the service entry. This method is supported for the benefit of hash tables and hash maps. It isimportant that the same members being used to determine equivalency are also used to determine the service entry's hashcode.

Returns:the hash code value for the service entry

Page 172



Class ServiceOrder

java.lang.Object | +-com.redback.npm.common.ServiceOrder

public class ServiceOrderextends java.lang.Object

This class represents an entry in the service order history table.

Fields

ADD_ACTIONpublic static final java.lang.String ADD_ACTION

REMOVE_ACTIONpublic static final java.lang.String REMOVE_ACTION

Constructors

ServiceOrderpublic ServiceOrder()

Methods

getSubAcctpublic java.lang.String getSubAcct()

Returns the subscriber account.


setSubAcctpublic void setSubAcct(java.lang.String sub)

Sets the subscriber account name.

Parameters:sub - the subscriber account name

Page 173

com.redback.npm.common.ServiceOrder



Returns the service identifier for this order.


setServiceIdpublic void setServiceId(java.lang.String service)

Sets the service identifier for this order.

Parameters:service - the service identifier


Returns the service name for this order.

Returns:the service name

setServiceNamepublic void setServiceName(java.lang.String service)

Sets the service name for this order.

Parameters:service - the service name

getDateTimepublic java.util.Date getDateTime()

Returns the date and time of this service order entry.

Returns:the date and time this service order entry was created

setDateTimepublic void setDateTime(java.util.Date when)

Sets the date and time of the service order entry.

Parameters:when - the date and time this service order entry was created

getActionpublic java.lang.String getAction()

Returns the action associated with this service order entry.

Returns:either the string "add" (ADD_ACTION) or "remove" (REMOVE_ACTION) depending on the action for this serviceorder entry

Page 174


setActionpublic void setAction(java.lang.String act) throws java.lang.IllegalArgumentException

Returns the action associated with this service order entry.

Parameters:act - either the string "add" (ADD_ACTION) or "remove" (REMOVE_ACTION) depending on the action for thisservice order entry.

Exceptions:IllegalArgumentException - if the act parameter is not either "add" or "remove"

Page 175



Class SessionAlreadyBoundException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.SessionAlreadyBoundException

public class SessionAlreadyBoundExceptionextends java.lang.Exception

This exception represents an error if the session you are attempting to bind to a pre-authenticated subscriber is already bound toanother subscriber.

Constructors

SessionAlreadyBoundExceptionpublic SessionAlreadyBoundException()

SessionAlreadyBoundExceptionpublic SessionAlreadyBoundException(java.lang.String message)

Parameters:message - the error message

Page 176

com.redback.npm.common.SessionAlreadyBoundException


Class SessionLimitException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.SessionLimitException

public class SessionLimitExceptionextends java.lang.Exception

This exception represents an error due to an attempt by a subscriber account to exceed the maximum number of logins defined bythe subscriber account's service subscriptions.

Constructors

SessionLimitExceptionpublic SessionLimitException()

SessionLimitExceptionpublic SessionLimitException(java.lang.String message)


SessionLimitExceptionpublic SessionLimitException(java.lang.String message, java.lang.Exception exception)

Parameters:message - a detailed error messageexception - the cause of this exception

Page 177

com.redback.npm.common.SessionLimitException


Class SubscriberAccountNameList

java.lang.Object | +-com.redback.npm.common.SubscriberAccountNameList

public class SubscriberAccountNameListextends java.lang.Object

A container for storing the results of a subscriber account name search. SubscriberAccountNameList holds a list of subscriber account names resulting from a subscriber account name search. It providesmethods to access query result data, including: (1) Whether or not more than the returned number of names resulted from a search.(2) The return limit (maximum number of objects which can be returned by an API server in one request) of the NetOp PM APIserver through which the search was performed. (3) The status code indicating the status of the search. The SubscriberAccountNameList also provides methods to set and retrieve previous and next cursor strings, which potentially canbe used to traverse forward and backward through a subscriber account name search result using multiple NetOp PM API calls.

See Also: SubscriberAccountManager#getSubscriberAccountNameList(String filter, int numRows)

Constructors

SubscriberAccountNameListpublic SubscriberAccountNameList(java.util.List names, boolean moreNamesAvailable, java.lang.String nextCursor, java.lang.String prevCursor, int returnLimit, SubscriberAccountNameList.StatusCode statusCode)

Creates a SubscriberAccountNameList initializing all members with specified parameters.

Methods

getMoreNamesAvailablepublic boolean getMoreNamesAvailable()

Indicates that more subscriber account names are available.

Returns:true if more subscriber account names than the number returned for a subscriber account name search are available;otherwise false

getNamespublic java.util.List getNames()

Returns the results, if any, from a subscriber account name search as a list.

Returns:a list containing subscriber account names matching the search

Page 178

com.redback.npm.common.SubscriberAccountNameList


getNextCursorpublic java.lang.String getNextCursor()

Returns a string containing information relevant to the previous call. It is intended to be passed as a filter parameter tothe API and used only by the API to return the next set of subscriber account names, if any, that result from a search to thecaller. Only valid for use when a SubscriberAccountNameList indicates that more names are available in a forwarddirection; for example, after the first API call or a subsequent call using this method to provide an API filter parameter.


getPrevCursorpublic java.lang.String getPrevCursor()

Returns a string containing information relevant to the previous call. It is intended to be passed as a filter parameter tothe API and used only by the API to return the previous set of subscriber account names, if any, that result from a search tothe caller. Only valid for use when a SubscriberAccountNameList has successfully traversed forward at least once usingthe getNextCursor method to provide a filter parameter, or when a SubscriberAccountNameList indicates that morenames are available in a backward direction, after one or more subsequent API calls using this method to provide an API.


getReturnLimitpublic int getReturnLimit()

Returns an integer representing the return limit for the API server through which the search was performed. The returnlimit of an API server is the maximum number of objects that will be returned by one request or API call.

Returns:an integer value of an API server's return limit

getStatusCodeOrdinalpublic int getStatusCodeOrdinal()

Returns an integer representing the status of the subscriber account name search from the API call.

Returns:an integer value representing the status of the subscriber account name search

getStatusCodepublic SubscriberAccountNameList.StatusCode getStatusCode()

Returns the StatusCode representing the status of the subscriber account name search from the API call.

Returns:a StatusCode representing the status of the subscriber account name search

Page 179

com.redback.npm.common.SubscriberAccountNameList


Class SubscriberAccountNameList.StatusCode

java.lang.Object | +-java.lang.Enum | +-com.redback.npm.common.SubscriberAccountNameList.StatusCode

public static final class SubscriberAccountNameList.StatusCodeextends java.lang.Enum

Enumerates valid status codes pertaining to a subscriber account name search. Valid status code values and definitions include: NO_RESULTS - no results exist for the submitted search filter RESULTS_FOUND - results exist for the submitted search filter SIZE_GREATER_THAN_RETURN_LIMIT - results exist for the submitted search filter, but the number of names requested waslarger than the API server's return limit INVALID_CURSOR_ARG - an invalid cursor argument was submitted; for instance, when no more rows are available

Fields

NO_RESULTSpublic static final com.redback.npm.common.SubscriberAccountNameList.StatusCodeNO_RESULTS

RESULTS_FOUNDpublic static final com.redback.npm.common.SubscriberAccountNameList.StatusCodeRESULTS_FOUND

SIZE_GREATER_THAN_RETURN_LIMITpublic static final com.redback.npm.common.SubscriberAccountNameList.StatusCodeSIZE_GREATER_THAN_RETURN_LIMIT

INVALID_CUSOR_ARGpublic static final com.redback.npm.common.SubscriberAccountNameList.StatusCodeINVALID_CUSOR_ARG

Methods

Page 180

com.redback.npm.common.SubscriberAccountNameList.StatusCode


valuespublic static SubscriberAccountNameList.StatusCode[] values()

valueOfpublic static SubscriberAccountNameList.StatusCode valueOf(java.lang.String name)

Page 181

com.redback.npm.common.SubscriberAccountNameList.StatusCode


Class SubscriberSession

java.lang.Object | +-com.redback.npm.common.SubscriberSessionSummary | +-com.redback.npm.common.SubscriberSession

public class SubscriberSessionextends SubscriberSessionSummary

This class represents a subscriber session in the NetOp PM database.

Constructors

SubscriberSessionpublic SubscriberSession()

Methods

getNASPortTypepublic java.lang.String getNASPortType()

Returns the NAS port type for this session.

Returns:the NAS port type for this session

setNASPortTypepublic void setNASPortType(java.lang.String type)

Sets the NAS port type for this session.

Parameters:type - the NAS port type

getMediumpublic java.lang.String getMedium()

Returns the network medium for this session.

Returns:the network medium

setMediumpublic void setMedium(java.lang.String med)

Sets the network medium for this session.

Parameters:

Page 182

com.redback.npm.common.SubscriberSession


med - the network medium

getSessionIppublic java.lang.String getSessionIp()

Returns the IP address for this session.

Returns:the IP address

setSessionIppublic void setSessionIp(java.lang.String ip)

Sets the IP address for this session.

Parameters:ip - the IP address


Returns the subscriber account name for this session.


setSubscriberAccountpublic void setSubscriberAccount(java.lang.String acct)

Sets the subscriber account name for this session.

Parameters:acct - the subscriber account name

getAcctSessionIdpublic java.lang.String getAcctSessionId()

Returns the accounting session identifier for this session.

Returns:the accounting session identifier

setAcctSessionIdpublic void setAcctSessionId(java.lang.String acctSessionId)

Sets the accounting session ID for this session.

Parameters:acctSessionId - the string accounting session identifier

getContextpublic java.lang.String getContext()

Returns the context for this session.

Page 183



Returns:the context

setContextpublic void setContext(java.lang.String context)

Sets the context for this session.

Parameters:context - the context within the node

getMacAddresspublic java.lang.String getMacAddress()

Returns the circuit MAC address for this session.

Returns:the MAC address

setMacAddresspublic void setMacAddress(java.lang.String macAddr)

Sets the circuit MAC address for this session.

Parameters:macAddr - the MAC address

getNASPortIdpublic java.lang.String getNASPortId()

Returns the NAS port identifier for this session.

Returns:the NAS port identifier

setNASPortIdpublic void setNASPortId(java.lang.String nasPortId)

Sets the NAS port identifier for this session.

Parameters:nasPortId - the NAS port identifier

getCallingStationIdpublic java.lang.String getCallingStationId()

Returns the calling station identifier for this session.

Returns:the calling station identifier

setCallingStationIdpublic void setCallingStationId(java.lang.String callingStationId)

Sets the calling station identifier for this session.

Page 184



Parameters:callingStationId - the calling station identifier

Page 185



Class SubscriberSessionSummary

java.lang.Object | +-com.redback.npm.common.SubscriberSessionSummary

public class SubscriberSessionSummaryextends java.lang.Object

This class holds a summary of a subscriber session.

Direct Known Subclasses:SubscriberSession

Constructors

SubscriberSessionSummarypublic SubscriberSessionSummary()

Methods

getSessionIdpublic java.lang.String getSessionId()

Returns the session identifier.

Returns:the session identifier

setSessionIdpublic void setSessionId(java.lang.String id)

Sets the session identifier.

Parameters:id - the session identifier to set

getStartTimepublic java.util.Date getStartTime()

Returns the start time for this session.

Returns:the start time

setStartTimepublic void setStartTime(java.util.Date start)

Sets the start time for this session.

Page 186

com.redback.npm.common.SubscriberSessionSummary


Parameters:start - the start time to set

getNasIdpublic java.lang.String getNasId()

Returns the NAS identifier for this session.

Returns:the NAS identifier

setNasIdpublic void setNasId(java.lang.String id)

Sets the NAS identifier for this session.

Parameters:id - the NAS identifier to set

getNasTypepublic java.lang.String getNasType()

Returns the NAS type for this session.

Returns:the NAS type

setNasTypepublic void setNasType(java.lang.String type)

Sets the NAS type for this session.

Parameters:type - the NAS type to set

getCircuitTypepublic java.lang.String getCircuitType()

Returns the circuit type for this session.

Returns:the circuit type

setCircuitTypepublic void setCircuitType(java.lang.String type)

Sets the circuit type for this session.

Parameters:type - the circuit type to set

Page 187

com.redback.npm.common.SubscriberSessionSummary


Class TooManyServicesSelectedException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.TooManyServicesSelectedException

public class TooManyServicesSelectedExceptionextends java.lang.Exception

This exception represents an error due to an attempt by a subscriber account to select too many service subscriptions. Currently nomore than 4 service subscriptions are allowed.

Constructors

TooManyServicesSelectedExceptionpublic TooManyServicesSelectedException()

TooManyServicesSelectedExceptionpublic TooManyServicesSelectedException(java.lang.String message)

Parameters:message - a detailed error message indicating too many services have been selected

Page 188

com.redback.npm.common.TooManyServicesSelectedException

Package

com.redback.npm.common.definition

Page 189


Class AttributeInUseException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.AttributeInUseException

public class AttributeInUseExceptionextends java.lang.Exception

This exception represents an error due to an attempt that was made to remove an attribute definition or to modify fields in anattribute definition that is still being used in the NetOp PM database.

Constructors

AttributeInUseExceptionpublic AttributeInUseException()

AttributeInUseExceptionpublic AttributeInUseException(java.lang.String message)


AttributeInUseExceptionpublic AttributeInUseException(java.lang.String message, java.lang.Throwable cause)


AttributeInUseExceptionpublic AttributeInUseException(java.lang.Throwable cause)


Page 190

com.redback.npm.common.definition.AttributeInUseException


Class DuplicateAttributeException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.DuplicateAttributeException

public class DuplicateAttributeExceptionextends java.lang.Exception

This exception represents an error when an attribute definition being added contains a name, database column, or attribute numberthat already exists in the NetOp PM system.

Constructors

DuplicateAttributeExceptionpublic DuplicateAttributeException()

DuplicateAttributeExceptionpublic DuplicateAttributeException(java.lang.String message)

Parameters:message - an error message that indicates an error was encountered

DuplicateAttributeExceptionpublic DuplicateAttributeException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates an error was encounteredcause - the throwable cause of the error

DuplicateAttributeExceptionpublic DuplicateAttributeException(java.lang.Throwable cause)


Page 191

com.redback.npm.common.definition.DuplicateAttributeException


Class DuplicateDBColumnException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.DuplicateDBColumnException

public class DuplicateDBColumnExceptionextends java.lang.Exception

This exception represents an error when a RADIUS attribute definition being added contains a database column that already existsin either the accounting table or the radius_attribute database table of the NetOp PM system.

Constructors

DuplicateDBColumnExceptionpublic DuplicateDBColumnException()

DuplicateDBColumnExceptionpublic DuplicateDBColumnException(java.lang.String message)

Parameters:message - an error message indicating a duplicate database column exists

DuplicateDBColumnExceptionpublic DuplicateDBColumnException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message indicating a duplicate database column existscause - the throwable cause of the error

DuplicateDBColumnExceptionpublic DuplicateDBColumnException(java.lang.Throwable cause)


Page 192

com.redback.npm.common.definition.DuplicateDBColumnException


Class DuplicateNASTypeException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.DuplicateNASTypeException

public class DuplicateNASTypeExceptionextends java.lang.Exception

This exception represents an error when a NAS type being added already exists in the NetOp PM system.

Constructors

DuplicateNASTypeExceptionpublic DuplicateNASTypeException()

DuplicateNASTypeExceptionpublic DuplicateNASTypeException(java.lang.String message)

Parameters:message - an error message indicating this NAS type already exists

DuplicateNASTypeExceptionpublic DuplicateNASTypeException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message indicating this NAS type already existscause - the throwable cause of the error

DuplicateNASTypeExceptionpublic DuplicateNASTypeException(java.lang.Throwable cause)


Page 193

com.redback.npm.common.definition.DuplicateNASTypeException


Class DuplicateRADIUSAttributeException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.DuplicateRADIUSAttributeException

public class DuplicateRADIUSAttributeExceptionextends java.lang.Exception

This exception represents an error when a RADIUS attribute definition being added contains a name, database column, or attributenumber that already exists in the NetOp PM system.

Constructors

DuplicateRADIUSAttributeExceptionpublic DuplicateRADIUSAttributeException()

DuplicateRADIUSAttributeExceptionpublic DuplicateRADIUSAttributeException(java.lang.String message)

Parameters:message - an error message that indicates an error was encountered

DuplicateRADIUSAttributeExceptionpublic DuplicateRADIUSAttributeException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates an error was encounteredcause - the throwable cause of the error

DuplicateRADIUSAttributeExceptionpublic DuplicateRADIUSAttributeException(java.lang.Throwable cause)


Page 194

com.redback.npm.common.definition.DuplicateRADIUSAttributeException


Class InvalidAttributeException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.InvalidAttributeException

public class InvalidAttributeExceptionextends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the attribute definition.

Constructors

InvalidAttributeExceptionpublic InvalidAttributeException()

InvalidAttributeExceptionpublic InvalidAttributeException(java.lang.String message)

Parameters:message - an error message that indicates the attribute definition is unrecognizable

InvalidAttributeExceptionpublic InvalidAttributeException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates the attribute definition is unrecognizablecause - the throwable cause of the error

InvalidAttributeExceptionpublic InvalidAttributeException(java.lang.Throwable cause)


Page 195

com.redback.npm.common.definition.InvalidAttributeException


Class InvalidNASTypeException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.InvalidNASTypeException

public class InvalidNASTypeExceptionextends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the NAS type definition.

Constructors

InvalidNASTypeExceptionpublic InvalidNASTypeException()

InvalidNASTypeExceptionpublic InvalidNASTypeException(java.lang.String message)

Parameters:message - an error message that indicates this NAS type definition is unrecognizable

InvalidNASTypeExceptionpublic InvalidNASTypeException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates this NAS type definition is unrecognizablecause - the throwable cause of the error

InvalidNASTypeExceptionpublic InvalidNASTypeException(java.lang.Throwable cause)


Page 196

com.redback.npm.common.definition.InvalidNASTypeException


Class InvalidRADIUSAttributeException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.InvalidRADIUSAttributeException

public class InvalidRADIUSAttributeExceptionextends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the RADIUS attribute definition.

Constructors

InvalidRADIUSAttributeExceptionpublic InvalidRADIUSAttributeException()

InvalidRADIUSAttributeExceptionpublic InvalidRADIUSAttributeException(java.lang.String message)

Parameters:message - an error message that indicates the RADIUS attribute definition is unrecognizable

InvalidRADIUSAttributeExceptionpublic InvalidRADIUSAttributeException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates the RADIUS attribute definition is unrecognizablecause - the throwable cause of the error

InvalidRADIUSAttributeExceptionpublic InvalidRADIUSAttributeException(java.lang.Throwable cause)


Page 197

com.redback.npm.common.definition.InvalidRADIUSAttributeException


Class NASTypeInUseException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.NASTypeInUseException

public class NASTypeInUseExceptionextends java.lang.Exception

This exception represents an error due to an attempt that was made to remove or update a NASType which is still being used in theNetOp PM system.

Constructors

NASTypeInUseExceptionpublic NASTypeInUseException()

NASTypeInUseExceptionpublic NASTypeInUseException(java.lang.String message)

Parameters:message - an error message that indicates you tried to remove this NAS type when it was already in use

NASTypeInUseExceptionpublic NASTypeInUseException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates you tried to remove this NAS type when it was already in usecause - the throwable cause of the error

NASTypeInUseExceptionpublic NASTypeInUseException(java.lang.Throwable cause)


Page 198

com.redback.npm.common.definition.NASTypeInUseException


Class RADIUSAttributeInUseException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.RADIUSAttributeInUseException

public class RADIUSAttributeInUseExceptionextends java.lang.Exception

This exception represents an error due to an attempt that was made to remove a RADIUS attribute definition or to modify fields ina RADIUS attribute definition that is still being used in the NetOp PM database.

Constructors

RADIUSAttributeInUseExceptionpublic RADIUSAttributeInUseException()

RADIUSAttributeInUseExceptionpublic RADIUSAttributeInUseException(java.lang.String message)


RADIUSAttributeInUseExceptionpublic RADIUSAttributeInUseException(java.lang.String message, java.lang.Throwable cause)


RADIUSAttributeInUseExceptionpublic RADIUSAttributeInUseException(java.lang.Throwable cause)


Page 199

com.redback.npm.common.definition.RADIUSAttributeInUseException


Class UnmodifiableAttributeException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.UnmodifiableAttributeException

public class UnmodifiableAttributeExceptionextends java.lang.Exception

This exception represents an error due to an attempt that was made to modify an unmodifiable field in an attribute definition.

Constructors

UnmodifiableAttributeExceptionpublic UnmodifiableAttributeException()

UnmodifiableAttributeExceptionpublic UnmodifiableAttributeException(java.lang.String message)


UnmodifiableAttributeExceptionpublic UnmodifiableAttributeException(java.lang.String message, java.lang.Throwable cause)


UnmodifiableAttributeExceptionpublic UnmodifiableAttributeException(java.lang.Throwable cause)


Page 200

com.redback.npm.common.definition.UnmodifiableAttributeException


Class UnmodifiableRADIUSAttributeException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.UnmodifiableRADIUSAttributeException

public class UnmodifiableRADIUSAttributeExceptionextends java.lang.Exception

This exception represents an error due to an attempt that was made to modify an unmodifiable field in a RADIUS attributedefinition.

Constructors

UnmodifiableRADIUSAttributeExceptionpublic UnmodifiableRADIUSAttributeException()

UnmodifiableRADIUSAttributeExceptionpublic UnmodifiableRADIUSAttributeException(java.lang.String message)


UnmodifiableRADIUSAttributeExceptionpublic UnmodifiableRADIUSAttributeException(java.lang.String message, java.lang.Throwable cause)


UnmodifiableRADIUSAttributeExceptionpublic UnmodifiableRADIUSAttributeException(java.lang.Throwable cause)


Page 201

com.redback.npm.common.definition.UnmodifiableRADIUSAttributeException

Package

com.redback.npm.common.definition.diameter

Page 202


Class DiameterPeerTypeInUseException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.diameter.DiameterPeerTypeInUseException

public class DiameterPeerTypeInUseExceptionextends java.lang.Exception

This exception represents an error due to an attempt that was made to remove or or update a DiameterPeerType which is stillbeing used in the NetOp PM system.

Constructors

DiameterPeerTypeInUseExceptionpublic DiameterPeerTypeInUseException()

DiameterPeerTypeInUseExceptionpublic DiameterPeerTypeInUseException(java.lang.String message)

Parameters:message - an error message that indicates you tried to remove this NAS type when it was already in use

DiameterPeerTypeInUseExceptionpublic DiameterPeerTypeInUseException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates you tried to remove this NAS type when it was already in usecause - the throwable cause of the error

DiameterPeerTypeInUseExceptionpublic DiameterPeerTypeInUseException(java.lang.Throwable cause)


Page 203

com.redback.npm.common.definition.diameter.DiameterPeerTypeInUseException


Class DuplicateDiameterPeerTypeException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.diameter.DuplicateDiameterPeerTypeException

public class DuplicateDiameterPeerTypeExceptionextends java.lang.Exception

This exception represents an error when a diameter peer type being added already exists in the NetOp PM system.

Constructors

DuplicateDiameterPeerTypeExceptionpublic DuplicateDiameterPeerTypeException()

DuplicateDiameterPeerTypeExceptionpublic DuplicateDiameterPeerTypeException(java.lang.String message)

Parameters:message - an error message indicating this NAS type already exists

DuplicateDiameterPeerTypeExceptionpublic DuplicateDiameterPeerTypeException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message indicating this NAS type already existscause - the throwable cause of the error

DuplicateDiameterPeerTypeExceptionpublic DuplicateDiameterPeerTypeException(java.lang.Throwable cause)


Page 204

com.redback.npm.common.definition.diameter.DuplicateDiameterPeerTypeException


Class InvalidDiameterPeerTypeException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.diameter.InvalidDiameterPeerTypeException

public class InvalidDiameterPeerTypeExceptionextends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the diameter peer type definition.

Constructors

InvalidDiameterPeerTypeExceptionpublic InvalidDiameterPeerTypeException()

InvalidDiameterPeerTypeExceptionpublic InvalidDiameterPeerTypeException(java.lang.String message)

Parameters:message - an error message that indicates this Credit Control Server type definition is unrecognizable

InvalidDiameterPeerTypeExceptionpublic InvalidDiameterPeerTypeException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates this Credit Control Server type definition is unrecognizablecause - the throwable cause of the error

InvalidDiameterPeerTypeExceptionpublic InvalidDiameterPeerTypeException(java.lang.Throwable cause)


Page 205

com.redback.npm.common.definition.diameter.InvalidDiameterPeerTypeException

Package

com.redback.npm.common.diameter

Page 206


Class DiameterRequestVariationInUseException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.diameter.DiameterRequestVariationInUseException

public class DiameterRequestVariationInUseExceptionextends java.lang.Exception

This exception represents an error due to an attempt that was made to remove or update a DiameterRequestVariationwhich isstill being used in the NetOp PM system.

Constructors

DiameterRequestVariationInUseExceptionpublic DiameterRequestVariationInUseException()

DiameterRequestVariationInUseExceptionpublic DiameterRequestVariationInUseException(java.lang.String message)

Parameters:message - an error message that indicates you tried to remove this diameter request variation when it was alreadyin use

DiameterRequestVariationInUseExceptionpublic DiameterRequestVariationInUseException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates you tried to remove this diameter request variation when it was alreadyin usecause - the throwable cause of the error

DiameterRequestVariationInUseExceptionpublic DiameterRequestVariationInUseException(java.lang.Throwable cause)


Page 207

com.redback.npm.common.diameter.DiameterRequestVariationInUseException


Class DuplicateDiameterPeerException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.diameter.DuplicateDiameterPeerException

public class DuplicateDiameterPeerExceptionextends java.lang.Exception

This exception represents an error when a Diameter Peer being added contains a name that already exists in the NetOp PM system.

Constructors

DuplicateDiameterPeerExceptionpublic DuplicateDiameterPeerException()

DuplicateDiameterPeerExceptionpublic DuplicateDiameterPeerException(java.lang.String message)


DuplicateDiameterPeerExceptionpublic DuplicateDiameterPeerException(java.lang.String message, java.lang.Throwable cause)


DuplicateDiameterPeerExceptionpublic DuplicateDiameterPeerException(java.lang.Throwable cause)


Page 208

com.redback.npm.common.diameter.DuplicateDiameterPeerException


Class DuplicateDiameterRequestVariationException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.diameter.DuplicateDiameterRequestVariationException

public class DuplicateDiameterRequestVariationExceptionextends java.lang.Exception

This exception represents an error when a diameter request variation being added already exists in the NetOp PM system.

Constructors

DuplicateDiameterRequestVariationExceptionpublic DuplicateDiameterRequestVariationException()

DuplicateDiameterRequestVariationExceptionpublic DuplicateDiameterRequestVariationException(java.lang.String message)

Parameters:message - an error message indicating this diameter request variation already exists

DuplicateDiameterRequestVariationExceptionpublic DuplicateDiameterRequestVariationException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message indicating this diameter request variation already existscause - the throwable cause of the error

DuplicateDiameterRequestVariationExceptionpublic DuplicateDiameterRequestVariationException(java.lang.Throwable cause)


Page 209

com.redback.npm.common.diameter.DuplicateDiameterRequestVariationException


Class InvalidDiameterPeerException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.diameter.InvalidDiameterPeerException

public class InvalidDiameterPeerExceptionextends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this Diameter Peer.

Constructors

InvalidDiameterPeerExceptionpublic InvalidDiameterPeerException()

InvalidDiameterPeerExceptionpublic InvalidDiameterPeerException(java.lang.String message)


InvalidDiameterPeerExceptionpublic InvalidDiameterPeerException(java.lang.String message, java.lang.Throwable cause)


InvalidDiameterPeerExceptionpublic InvalidDiameterPeerException(java.lang.Throwable cause)


Page 210

com.redback.npm.common.diameter.InvalidDiameterPeerException


Class InvalidDiameterRequestVariationException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.diameter.InvalidDiameterRequestVariationException

public class InvalidDiameterRequestVariationExceptionextends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the diameter request variation.

Constructors

InvalidDiameterRequestVariationExceptionpublic InvalidDiameterRequestVariationException()

InvalidDiameterRequestVariationExceptionpublic InvalidDiameterRequestVariationException(java.lang.String message)

Parameters:message - an error message that indicates this diameter request variation is unrecognizable

InvalidDiameterRequestVariationExceptionpublic InvalidDiameterRequestVariationException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates this diameter request variation is unrecognizablecause - the throwable cause of the error

InvalidDiameterRequestVariationExceptionpublic InvalidDiameterRequestVariationException(java.lang.Throwable cause)


Page 211

com.redback.npm.common.diameter.InvalidDiameterRequestVariationException


Class InvalidDiameterRequestVariationTypeException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.diameter.InvalidDiameterRequestVariationTypeException

public class InvalidDiameterRequestVariationTypeExceptionextends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the diameter request variation type.

Constructors

InvalidDiameterRequestVariationTypeExceptionpublic InvalidDiameterRequestVariationTypeException()

InvalidDiameterRequestVariationTypeExceptionpublic InvalidDiameterRequestVariationTypeException(java.lang.String message)

Parameters:message - an error message that indicates this diameter request variation type is unrecognizable

InvalidDiameterRequestVariationTypeExceptionpublic InvalidDiameterRequestVariationTypeException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates this diameter request variation type is unrecognizablecause - the throwable cause of the error

InvalidDiameterRequestVariationTypeExceptionpublic InvalidDiameterRequestVariationTypeException(java.lang.Throwable cause)


Page 212

com.redback.npm.common.diameter.InvalidDiameterRequestVariationTypeException

Package

com.redback.npm.common.ldap

Page 213

com.redback.npm.common.ldap

Class InvalidLdapProxyServerException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.proxy.InvalidProxyServerException | +-com.redback.npm.common.ldap.InvalidLdapProxyServerException

public class InvalidLdapProxyServerExceptionextends InvalidProxyServerException

This exception represents an error due to NPM being unable to recognize the ldap proxy server.

Constructors

InvalidLdapProxyServerExceptionpublic InvalidLdapProxyServerException()

InvalidLdapProxyServerExceptionpublic InvalidLdapProxyServerException(java.lang.String message)


InvalidLdapProxyServerExceptionpublic InvalidLdapProxyServerException(java.lang.String message, java.lang.Throwable cause)


InvalidLdapProxyServerExceptionpublic InvalidLdapProxyServerException(java.lang.Throwable cause)


Page 214

com.redback.npm.common.ldap.InvalidLdapProxyServerException

Package

com.redback.npm.common.license

Page 215

com.redback.npm.common.license

Class InvalidLicenseException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.license.InvalidLicenseException

public class InvalidLicenseExceptionextends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this license key.

Constructors

InvalidLicenseExceptionpublic InvalidLicenseException(java.lang.String message)


Page 216

com.redback.npm.common.license.InvalidLicenseException

Package

com.redback.npm.common.racs

Page 217

com.redback.npm.common.racs

Class ResourceRequestDeniedException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.racs.ResourceRequestDeniedException

public class ResourceRequestDeniedExceptionextends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to grant the requested resources.

Fields

PORT_CONGESTION_POINTpublic static final java.lang.String PORT_CONGESTION_POINT

ACCESS_NODE_CONGESTION_POINTpublic static final java.lang.String ACCESS_NODE_CONGESTION_POINT

RG_CONGESTION_POINTpublic static final java.lang.String RG_CONGESTION_POINT

UNKNOWN_CONGESTION_POINTpublic static final java.lang.String UNKNOWN_CONGESTION_POINT

Constructors

ResourceRequestDeniedExceptionpublic ResourceRequestDeniedException()

ResourceRequestDeniedExceptionpublic ResourceRequestDeniedException(java.lang.String message)


Page 218

com.redback.npm.common.racs.ResourceRequestDeniedException

ResourceRequestDeniedExceptionpublic ResourceRequestDeniedException(java.lang.Throwable cause)


ResourceRequestDeniedExceptionpublic ResourceRequestDeniedException(java.lang.String message, java.lang.Throwable cause)


ResourceRequestDeniedExceptionpublic ResourceRequestDeniedException(java.lang.String cpLevelName, java.lang.String cpId)

Parameters:cpLevelName - the congestion point level name--could be Port, Access, RG, or UnknowncpId - the congestion point identifier

ResourceRequestDeniedExceptionpublic ResourceRequestDeniedException(java.lang.String cpLevelName, java.lang.String cpId, java.lang.String message)

Parameters:cpLevelName - the congestion point level name--could be Port, Access, RG, or UnknowncpId - the congestion point identifiermessage - a detailed error message

ResourceRequestDeniedExceptionpublic ResourceRequestDeniedException(java.lang.String cpLevelName, java.lang.String cpId, java.lang.Throwable cause)

Parameters:cpLevelName - the congestion point level name--could be Port, Access, RG, or UnknowncpId - the congestion point identifiercause - the throwable cause of the error

Page 219



ResourceRequestDeniedExceptionpublic ResourceRequestDeniedException(java.lang.String cpLevelName, java.lang.String cpId, java.lang.String message, java.lang.Throwable cause)

Parameters:cpLevelName - the congestion point level name--could be Port, Access, RG, or UnknowncpId - the congestion point identifiermessage - a detailed error messagecause - the throwable cause of the error

Methods

getCongestionPointLevelNamepublic java.lang.String getCongestionPointLevelName()

Returns the congestion point level name.

Returns:the congestion point level name--could be Port, Access, RG, or Unknown

getCongestionPointIdpublic java.lang.String getCongestionPointId()

Returns the congestion point identifier.

Returns:the congestion point identifier

getSubscriberCongestionpublic java.lang.String getSubscriberCongestion()

Returns a Y (yes) if there is subscriber congestion and an N (no) if not.

Returns:Y to indicate there is subscriber congestion; otherwise returns an N

Page 220


Package

com.redback.npm.common.radius

Page 221

com.redback.npm.common.radius

Class InvalidRadiusProxyServerException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.proxy.InvalidProxyServerException | +-com.redback.npm.common.radius.InvalidRadiusProxyServerException

public class InvalidRadiusProxyServerExceptionextends InvalidProxyServerException

This exception represents an error due to NPM being unable to recognize the radius proxy server.

Constructors

InvalidRadiusProxyServerExceptionpublic InvalidRadiusProxyServerException()

InvalidRadiusProxyServerExceptionpublic InvalidRadiusProxyServerException(java.lang.String message)


InvalidRadiusProxyServerExceptionpublic InvalidRadiusProxyServerException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - a detailed messagecause - the throwable cause of the error

InvalidRadiusProxyServerExceptionpublic InvalidRadiusProxyServerException(java.lang.Throwable cause)


Page 222

com.redback.npm.common.radius.InvalidRadiusProxyServerException

Package

com.redback.npm.common.service

Page 223


Class DuplicateServiceAttributeVariationException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.service.DuplicateServiceAttributeVariationException

public class DuplicateServiceAttributeVariationExceptionextends java.lang.Exception

This exception represents an error when a service attribute variation being added already exists in the NetOp PM system.

Constructors

DuplicateServiceAttributeVariationExceptionpublic DuplicateServiceAttributeVariationException()

DuplicateServiceAttributeVariationExceptionpublic DuplicateServiceAttributeVariationException(java.lang.String message)

Parameters:message - an error message indicating this service attribute variation already exists

DuplicateServiceAttributeVariationExceptionpublic DuplicateServiceAttributeVariationException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message indicating this service attribute variation already existscause - the throwable cause of the error

DuplicateServiceAttributeVariationExceptionpublic DuplicateServiceAttributeVariationException(java.lang.Throwable cause)


Page 224

com.redback.npm.common.service.DuplicateServiceAttributeVariationException


Class InvalidServiceAttributeVariationException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.service.InvalidServiceAttributeVariationException

public class InvalidServiceAttributeVariationExceptionextends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the service attribute variation.

Constructors

InvalidServiceAttributeVariationExceptionpublic InvalidServiceAttributeVariationException()

InvalidServiceAttributeVariationExceptionpublic InvalidServiceAttributeVariationException(java.lang.String message)

Parameters:message - an error message that indicates this service attribute variation is unrecognizable

InvalidServiceAttributeVariationExceptionpublic InvalidServiceAttributeVariationException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates this service attribute variation is unrecognizablecause - the throwable cause of the error

InvalidServiceAttributeVariationExceptionpublic InvalidServiceAttributeVariationException(java.lang.Throwable cause)


Page 225

com.redback.npm.common.service.InvalidServiceAttributeVariationException


Class InvalidServiceAttributeVariationTypeException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.service.InvalidServiceAttributeVariationTypeException

public class InvalidServiceAttributeVariationTypeExceptionextends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the service attribute variation type.

Constructors

InvalidServiceAttributeVariationTypeExceptionpublic InvalidServiceAttributeVariationTypeException()

InvalidServiceAttributeVariationTypeExceptionpublic InvalidServiceAttributeVariationTypeException(java.lang.String message)

Parameters:message - an error message that indicates this service attribute variation type is unrecognizable

InvalidServiceAttributeVariationTypeExceptionpublic InvalidServiceAttributeVariationTypeException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates this service attribute variation type is unrecognizablecause - the throwable cause of the error

InvalidServiceAttributeVariationTypeExceptionpublic InvalidServiceAttributeVariationTypeException(java.lang.Throwable cause)


Page 226

com.redback.npm.common.service.InvalidServiceAttributeVariationTypeException


Class ServiceAttributeVariationInUseException

java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.service.ServiceAttributeVariationInUseException

public class ServiceAttributeVariationInUseExceptionextends java.lang.Exception

This exception represents an error due to an attempt that was made to remove or update a ServiceAttributeVariationwhichis still being used in the NetOp PM system.

Constructors

ServiceAttributeVariationInUseExceptionpublic ServiceAttributeVariationInUseException()

ServiceAttributeVariationInUseExceptionpublic ServiceAttributeVariationInUseException(java.lang.String message)

Parameters:message - an error message that indicates you tried to remove this service attribute variation when it was alreadyin use

ServiceAttributeVariationInUseExceptionpublic ServiceAttributeVariationInUseException(java.lang.String message, java.lang.Throwable cause)

Parameters:message - an error message that indicates you tried to remove this service attribute variation when it was alreadyin usecause - the throwable cause of the error

ServiceAttributeVariationInUseExceptionpublic ServiceAttributeVariationInUseException(java.lang.Throwable cause)


Page 227

Index

NetOP user guide

Documents

Transcript of NetOP user guide