NetOP User Guide

NetOp Policy Manager API (Javadoc) Guide
Release 6.1.5 Part Number 2/1551-CRA 119 1030/1 Uen A
Corporate Headquarters Redback Networks Inc. 100 Headquarters Drive San Jose, CA 95134-1362 USA http://www.redback.com Tel: +1 408 750 5000
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 Restrictions

All 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.
Disclaimer
No 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.
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 APIs 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
Interface 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)
NetOp PM API Method Names and Parameter Types

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

Method 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)
NetOp Policy Manager API Guide (Javadoc Version)
Table 1
Interface ProxyMgmtIfc

Method
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 Deprecated changeAndApplyWholesaleServicesToSubAcctName(String subAcctName, String[] serviceIds) 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)
Table 1
Interface

Method getMeteredVolumeUsageForSubSession(String ipAddr) getSelectedServicesForSubAcctName(String subAcctName) getSelectedServicesForSubSession(String ipAddr)
Deprecated Deprecated
getSelectedWholesaleServicesForSubAcctName(String subAcctName) 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 Deprecated
removeAllWholesaleServices(String subAcctName) 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)
Table 1
Interface

Method 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)
Table 1
Interface

Method updateSubscriberAccount(SubscriberAccount subAcct) updateSubscriberAccountXML(String subAcctXML)
Package
com.redback.npm.api.admin
Page 1
com.redback.npm.api.admin.ConfigAttributeTypeIfc
Interface ConfigAttributeTypeIfc
public interface ConfigAttributeTypeIfc extends java.rmi.Remote
ConfigAttributeTypeIfc is a web services endpoint that lets you add, delete, or update additional attributes.
Methods
addAttributeTypeXML
public 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 Attributes to 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 table DuplicateAttributeException - if one or more of the Name/Vendor-id and AttributeNumber/DBColumn already exist in the database InvalidLicenseException - if the NAS type to be supported for this attribute is a third-party NAS type; if there is no license for the Third-party Vendor Support feature InvalidNASTypeException - if this NAS type is not a valid type InvalidAttributeException - if the XML representation does not pass the validation; if the DBColumn specified in this XML representation is already in use RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
getAllAttributeTypesXML
public 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 occurs SQLException - if a database access error occurs Since:
(continued on next page)
Page 2
(continued from last page)
6.1.5
getAttributeTypeXML
public 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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
removeAttributeType
public 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 system AttributeInUseException - if the attribute with the specified name is currently in use RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
updateAttributeTypeXML
public 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; if there is no license for the Third-party Vendor Support feature InvalidAttributeException - if the attribute with the specified name cannot be found in the system AttributeInUseException - if the attribute with the specified name is currently in use RemoteException - if an unexpected error occurs SQLException - if a database access error occurs UnmodifiableAttributeException - if an attempt is made to modify this database or the restricted fields of a attribute definition Since: 6.1.5
Page 4
com.redback.npm.api.admin.ConfigDiameterPeerTypeIfc
Interface ConfigDiameterPeerTypeIfc
public interface ConfigDiameterPeerTypeIfc extends java.rmi.Remote
ConfigDiameterPeerTypeIfc is a web services endpoint that enables you to add, retrieve, modify, and remove Diameter Peer type information in the NetOp PM database.
Methods
addDiameterPeerTypeXML
public 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 PM database. Exceptions: DuplicateDiameterPeerTypeException - if this Diameter Peer Type already exists in the NetOp PM database InvalidLicenseException - if there is no license for the Credit Control feature InvalidDiameterPeerTypeException - if the XML representation does not pass the validation RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.4.4
getAllDiameterPeerTypesXML
public 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 Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.4.4
Page 5
getDiameterPeerTypeXML
public 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 the specified Credit Control Server type is not in the database RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.4.4
removeDiameterPeerType
public 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 the system DiameterPeerTypeInUseException - if the Diameter Peer type with the specified name is currently in use RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.4.4
updateDiameterPeerTypeXML
public 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 PM database 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 found in the system DiameterPeerTypeInUseException - if the Diameter Peer type with the specified name is currently in use RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.4.4
Page 7
com.redback.npm.api.admin.ConfigDiameterRequestVariationTypeIfc
Interface ConfigDiameterRequestVariationTypeIfc
public interface ConfigDiameterRequestVariationTypeIfc extends java.rmi.Remote
ConfigDiameterRequestVariationTypeIfc is a web services endpoint that enables you to retrieve diameter request variation types in the NetOp PM system.
Methods
getAllDiameterRequestVariationTypesXML
public java.lang.String getAllDiameterRequestVariationTypesXML() throws java.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 Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
getDiameterRequestVariationTypeXML
public java.lang.String getDiameterRequestVariationTypeXML(java.lang.String diameterRequestType) throws InvalidDiameterRequestVariationTypeException, 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 cannot be found in the system. RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
Page 8
com.redback.npm.api.admin.ConfigNASTypeIfc
Interface ConfigNASTypeIfc
public interface ConfigNASTypeIfc extends java.rmi.Remote
ConfigNASTypeIfc is a web services endpoint that enables you to add, retrieve, modify, and remove NAS type information in the NetOp PM database.
Methods
addNASTypeXML
public 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 database InvalidLicenseException - if there is no license for the Third-party Vendor Support feature InvalidNASTypeException - if the XML representation does not pass the validation RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
getAllNASTypesXML
public 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 Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
Page 9
getNASTypeXML
public 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 NAS type is not in the database RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
removeNASType
public 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 system NASTypeInUseException - if the NAS type with the specified name is currently in use RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
updateNASTypeXML
public 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 feature InvalidNASTypeException - 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 use RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
Page 11
com.redback.npm.api.admin.ConfigRADIUSAttributeIfc
Interface ConfigRADIUSAttributeIfc
public interface ConfigRADIUSAttributeIfc extends java.rmi.Remote
ConfigRADIUSAttributeIfc is a web services endpoint that lets you add, delete, or update additional RADIUS attributes.
Methods
addRADIUSAttributeXML
public 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 the DBColumn 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 PM database Exceptions: DuplicateDBColumnException - if the specified DBColumn already exists in this accounting table or radius_attributes table DuplicateRADIUSAttributeException - if one or more of the Name/Vendor-id and AttributeNumber/DBColumn already exist in the database InvalidLicenseException - if the NAS type to be supported for this RADIUS attribute is a third-party NAS type; if there is no license for the Third-party Vendor Support feature InvalidNASTypeException - if this NAS type is not a valid type InvalidRADIUSAttributeException - if the XML representation does not pass the validation; if the DBColumn specified in this XML representation is already in use RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 5.0.5
getAllRADIUSAttributesXML
public 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 Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs
Page 12
Since: 5.0.5
getRADIUSAttributeXML
public 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 found in the system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 5.0.5
removeRADIUSAttribute
public 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 in the system RADIUSAttributeInUseException - if the RADIUS attribute with the specified name is currently in use RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 5.0.5
updateRADIUSAttributeXML
public 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 PM database Exceptions: InvalidLicenseException - if the NAS type to be supported for this RADIUS attribute is a third-party NAS type; if there is no license for the Third-party Vendor Support feature InvalidNASTypeException - if this NAS type is not a valid type. InvalidRADIUSAttributeException - if the RADIUS attribute with the specified name cannot be found in the system RADIUSAttributeInUseException - if the RADIUS attribute with the specified name is currently in use RemoteException - if an unexpected error occurs SQLException - if a database access error occurs UnmodifiableRADIUSAttributeException - if an attempt is made to modify this database or the restricted fields of a RADIUS attribute definition Since: 5.0.5
Page 14
com.redback.npm.api.admin.DiameterPeerMgmtIfc
Interface DiameterPeerMgmtIfc
public interface DiameterPeerMgmtIfc extends java.rmi.Remote
DiameterPeerMgmtIfc is a web services endpoint that enables you to add, retrieve, modify, and remove Diameter Peer configuration information in the NetOp PM database.
Methods
addDiameterPeerXML
public 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 database InvalidLicenseException - if there is no license for the Credit Control feature InvalidDiameterPeerException - if the XML representation does not pass the validation java.rmi.RemoteException - if an unexpected error occurs java.sql.SQLException - if a database access error occurs Since: 6.1.5
getAllDiameterPeersXML
public 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 Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
Page 15
getDiameterPeerXML
public 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 specified Credit Control Server is not in the database RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
removeDiameterPeer
public 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 the system DiameterPeerInUseException - if the Diameter Peer with the specified name is currently in use RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
updateDiameterPeerXML
public 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 the system DiameterPeerInUseException - if the Diameter Peer with the specified name is currently in use RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
Page 17
com.redback.npm.api.admin.DiameterRequestVariationMgmtIfc
Interface DiameterRequestVariationMgmtIfc
public interface DiameterRequestVariationMgmtIfc extends java.rmi.Remote
DiameterRequestVariationMgmtIfc is a web services endpoint that enables you to retrieve diameter request variations in the NetOp PM system.
Methods
addDiameterRequestVariationXML
public void addDiameterRequestVariationXML(java.lang.String diameterRequestVariationXML) 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 are contained in an XML document. Parameters: diameterRequestVariationXML - the XML representation for the new Diameter Request Variation Exceptions: InvalidLicenseException - if not licensed for Diameter Function DuplicateDiameterRequestVariationException - if this diameter request variation already exists in the NetOp PM database InvalidDiameterRequestVariationException - if the XML representation does not pass the validation RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
updateDiameterRequestVariationXML
public void updateDiameterRequestVariationXML(java.lang.String diameterRequestVariationXML) throws InvalidDiameterRequestVariationException, 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 Variation are contained in an XML document. Parameters: diameterRequestVariationXML - the XML representation for the Credit Control Request Variation Exceptions: InvalidLicenseException - if not licensed for Diameter Function InvalidDiameterRequestVariationException - if the diameter request variation with the specified name cannot be found in the system
Page 18
RemoteException - if an unexpected error occurs DiameterRequestVariationInUseException - if the diameter request variation with the specified name is currently in use SQLException - if a database access error occurs Since: 6.1.5
removeDiameterRequestVariation
public void removeDiameterRequestVariation(java.lang.String diameterRequestVariationName) 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 name is currently in use InvalidDiameterRequestVariationException - if the diameter request variation with the specified name cannot be found in the system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
getAllDiameterRequestVariationsXML
public 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 Variation are contained in an XML document. Returns: the XML representation of the Diameter Request Variation Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
getDiameterRequestVariationXML
public java.lang.String getDiameterRequestVariationXML(java.lang.String diameterRequestVariationName) throws InvalidDiameterRequestVariationException, java.rmi.RemoteException, java.sql.SQLException Get an existing Diameter Request Variation to the NetOp PM database. The details of the Diameter Request Variation are contained in an XML document.
Page 19
Parameters: diameterRequestVariationName - the name for the Diameter Request Variation Returns: the XML representation of the Diameter Request Variation Exceptions: InvalidDiameterRequestVariationException - if the diameter request variations with the specified type cannot be found in the system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
getDiameterRequestVariationsByTypeXML
public java.lang.String getDiameterRequestVariationsByTypeXML(java.lang.String diameterRequestVariationType) throws InvalidDiameterRequestVariationException, java.rmi.RemoteException, java.sql.SQLException Get an existing Diameter Request Variation by type from the NetOp PM database. The details of the Diameter Request Variation are contained in an XML document. Parameters: diameterRequestVariationType - the name for the Diameter Request Variation Returns: the XML representation of the Diameter Request Variation Exceptions: InvalidDiameterRequestVariationException - if the diameter request variation with the specified type cannot be found in the system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
Page 20
com.redback.npm.api.admin.LdapProxyServer
Class LdapProxyServer
java.lang.Object | +-com.redback.npm.api.admin.ProxyServer | +-com.redback.npm.api.admin.LdapProxyServer
public class LdapProxyServer extends ProxyServer

This class represents a single LDAP server to which NPM can proxy an authentication request.
Constructors
LdapProxyServer
public LdapProxyServer() Default constructor
Methods
getBaseDN
public java.lang.String getBaseDN() Get the base DN for searches Returns: the base DN for searches
setBaseDN
public void setBaseDN(java.lang.String baseDN) Set the base DN for searches Parameters: baseDN - the base DN for searches
getNameAttribute
public java.lang.String getNameAttribute() Get the username attribute Returns: the username attribute
setNameAttribute
public 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.NAS
Class NAS
java.lang.Object | +-com.redback.npm.api.admin.NAS
public class NAS extends java.lang.Object

This class provides a SOAP representation of the NASInfo class.
Constructors
NAS
public NAS()
Methods
getDefaultRealm
public java.lang.String getDefaultRealm() Returns the default realm of this NAS. Returns: the default realm of this NAS
setDefaultRealm
public void setDefaultRealm(java.lang.String defaultRealm) Sets the default realm of this NAS. Parameters: defaultRealm - the new default realm for this NAS
getId
public java.lang.String getId() Returns the identifier for this NAS. Returns: the identifier for this NAS
setId
public void setId(java.lang.String id) Sets the identifier for this NAS. Parameters: id - the identifier for this NAS
Page 23
getIPAddress
public java.lang.String getIPAddress() Returns the ip address for this NAS. Returns: the ip address for this NAS
setIPAddress
public void setIPAddress(java.lang.String ipAddress) Sets the ip address for this NAS. Parameters: ipAddress - the new ip address for this NAS
getSecret
public java.lang.String getSecret() Returns the shared secret for this NAS. Returns: the shared secret for this NAS
setSecret
public void setSecret(java.lang.String secret) Sets the shared secret for this NAS. Parameters: secret - the new shared secret for this NAS
getSoftwareVersion
public java.lang.String getSoftwareVersion() Returns the software version for this NAS. Returns: the software version for this NAS
setSoftwareVersion
public void setSoftwareVersion(java.lang.String softwareVersion) Sets the software version for this NAS. Parameters: softwareVersion - the new software version for this NAS
getSNMPCommunity
public java.lang.String getSNMPCommunity() Returns the SNMP community for this NAS. Returns:
Page 24
the SNMP community for this NAS
setSNMPCommunity
public void setSNMPCommunity(java.lang.String SNMPCommunity) Sets the SNMP community for this NAS. Parameters: SNMPCommunity - the new SNMP community for this NAS
getType
public java.lang.String getType() Returns the type for this NAS. Returns: the type for this NAS
setType
public void setType(java.lang.String type) Sets the type for this NAS. Parameters: type - the new type for this NAS
getCoAPort
public java.lang.Integer getCoAPort() Returns the CoAPort of this NAS Returns: the CoAPort this NAS is listening on
setCoAPort
public void setCoAPort(java.lang.Integer port) Sets the CoA port of this NAS Parameters: port - the CoAPort his NAS is listening on
getCoASecret
public java.lang.String getCoASecret() Returns the CoASecret of this NAS Returns: the CoASecret of this NAS
setCoASecret
public 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
com.redback.npm.api.admin.NASMgmtIfc
Interface NASMgmtIfc
public interface NASMgmtIfc extends java.rmi.Remote
NASMgmtIfc is a web services endpoint that enables you to add, retrieve, modify, and remove NAS configuration information in the NetOp PM database.
Methods
addNAS
public 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 exists InvalidLicenseException - if the NAS type of this NAS is a third-party NAS type, and there is no valid license for the Third-party Vendor Support feature InvalidNASException - if the specified NAS is not valid RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
addNASXML
public 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 exists InvalidLicenseException - if the NAS type for this NAS is a third-party NAS type, and there is no valid license for the Third-party Vendor Support feature InvalidNASException - if the specified NASXML is not valid RemoteException - if an unexpected error occurs SQLException - if a database access error occurs
Page 27
Since: 6.0.3
getAllNAS
public 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 Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
getAllNASXML
public 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 Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
getNAS
public 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 exist RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
Page 28
getNASXML
public 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. Parameters: nasId - the NAS identifier Returns: an XML representation for this NAS configuration specified by nasId Exceptions: InvalidNASException - if the specified nasId does not exist RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
removeNAS
public 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. Parameters: nasId - the NAS identifier Exceptions: InvalidNASException - if the specified nasId does not exist NASInUseException - if the specified nasId is still being referenced RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
updateNAS
public 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 valid license for the Third-party Vendor Support feature InvalidNASException - if the specified NAS does not exist
Page 29
RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
updateNASXML
public 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 valid license for the Third-party Vendor Support feature InvalidNASException - if the specified NAS does not exist RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0.3
Page 30
com.redback.npm.api.admin.ProxyInfo
Class ProxyInfo
java.lang.Object | +-com.redback.npm.api.admin.ProxyInfo
public class ProxyInfo extends java.lang.Object

Objects of this class encapsulate the NetOp PM proxy configuration for a realm.
Constructors
ProxyInfo
public ProxyInfo() Default constructor
Methods
getRealm
public java.lang.String getRealm() Returns the realm associated with this proxy configuration information. Returns: the realm associated with this proxy configuration
setRealm
public 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
getProxyType
public 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
setProxyType
public 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
getAlgorithm
public java.lang.String getAlgorithm() Returns the algorithm that the NetOp PM API server and the NetOp PM RADIUS servers use for distributing RADIUS or LDAP messages to external RADIUS servers or external LDAP servers. Returns: the algorithm used, either first or round robin
setAlgorithm
public 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 or LDAP messages to external RADIUS servers or external LDAP servers. Parameters: algorithm - the algorithm to use, either first or round robin
isProxyLoginAccessRequest
public boolean isProxyLoginAccessRequest() Returns if this realm is configured to proxy login access requests. Returns: true if login access requests are proxied, otherwise false
setProxyLoginAccessRequest
public void setProxyLoginAccessRequest(boolean proxy) Sets this realm's configuration for proxying login access requests. Parameters: proxy - whether login access requests are to be proxied
isProxyServiceChangeAccessRequest
public 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
setProxyServiceChangeAccessRequest
public 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
isProxyAcctStart
public 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
setProxyAcctStart
public 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
isProxyAcctStop
public boolean isProxyAcctStop() Determines whether this realm is configured to proxy Accounting-Stop records. Returns: true if Accounting-Stop records are proxied, otherwise false
setProxyAcctStop
public 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
isProxyAcctOn
public boolean isProxyAcctOn() Determines whether this realm is configured to proxy Accounting-On records. Returns: true if Accounting-On records are proxied, otherwise false
setProxyAcctOn
public 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
isProxyAcctOff
public boolean isProxyAcctOff() Determines whether this realm is configured to proxy Accounting-Off records. Returns: true if Accounting-Off records are proxied, otherwise false
setProxyAcctOff
public 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
isProxyAcctAlive
public boolean isProxyAcctAlive() Determines whether this realm is configured to proxy Accounting-Alive records. Returns: true if Accounting-Alive records are proxied, otherwise false
setProxyAcctAlive
public 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
isStoreAcctStart
public boolean isStoreAcctStart() Determines whether this realm is configured to store Accounting-Start records. Returns: true if Accounting-Start records are stored, otherwise false
setStoreAcctStart
public 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
isStoreAcctStop
public boolean isStoreAcctStop() Determines whether this realm is configured to store Accounting-Stop records. Returns: true if Accounting-Stop records are stored, otherwise false
setStoreAcctStop
public 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
isStoreAcctOn
public 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
setStoreAcctOn
public 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
isStoreAcctOff
public boolean isStoreAcctOff() Determines whether this realm is configured to store Accounting-Off records. Returns: true if Accounting-Off records are stored, otherwise false
setStoreAcctOff
public 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
isStoreAcctAlive
public boolean isStoreAcctAlive() Determines whether this realm is configured to store Accounting-Alive records. Returns: true if Accounting-Alive records are stored, otherwise false
setStoreAcctAlive
public 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
isDeleteOnAcctOff
public boolean isDeleteOnAcctOff() Determines whether this realm is configured to delete nas_session entries when an Accounting-Off record is received from the NAS. Returns: true if nas_session entries are to be removed when an Accounting-Off is received from the NAS, otherwise false
Page 35
setDeleteOnAcctOff
public void setDeleteOnAcctOff(boolean del) Informs the system whether this realm is configured to delete nas_session entries when an Accounting-Off record is received from the NAS. Parameters: del - whether nas_session entries are to be removed when Accounting-Off record is received
getDefaultWebLogonService
public 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
setDefaultWebLogonService
public 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
getDefaultService
public java.lang.String getDefaultService() Returns the default service identifier. The default service offering is used if the subscriber has no services configured in the NetOp PM database. Returns: the default service identifier
setDefaultService
public void setDefaultService(java.lang.String serv) Sets the realm's default service. Parameters: serv - the service identifier of the default service for this realm
getInvalidLoginRedirectService
public java.lang.String getInvalidLoginRedirectService() Returns the invalid login redirect service identifier. The invalid login redirect service is used to redirect PPPoA or PPPoE subscribers who attempt to log on with an invalid username or incorrect password. Returns: the invalid login service identifier
setInvalidLoginRedirectService
public 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
isDoubleAccessSuppression
public boolean isDoubleAccessSuppression() Determines whether the NetOp PM system is configured to suppress the proxy of two RADIUS Access-Request packets from 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
setDoubleAccessSuppression
public void setDoubleAccessSuppression(boolean suppress) Informs the system whether to suppress the proxy of two RADIUS Access-Request packets for this realm when a subscriber logs on through the web portal. Parameters: suppress - whether double Access-Request packets are to be suppressed
getInvalidLocationRedirectService
public java.lang.String getInvalidLocationRedirectService() Returns the invalid location redirect service identifier. The invalid location redirect service is used to redirect PPPoA or PPPoE subscribers who attempt to log on from an invalid location. Returns: the invalid location service identifier
setInvalidLocationRedirectService
public void setInvalidLocationRedirectService(java.lang.String serv) Sets the realm's invalid location redirect service identifier. Parameters: serv - the invalid location redirect service identifier
getInactiveAccountRedirectService
public java.lang.String getInactiveAccountRedirectService() Returns the inactive account redirect service identifier. The inactive account redirect service is used to redirect PPPoA or PPPoE subscribers who attempt to log on when the subscriber account is inactive. Returns: the inactive account redirect service identifier
setInactiveAccountRedirectService
public 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
getRadiusProxyServers
public 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
setRadiusProxyServers
public 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
getLdapProxyServers
public 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
setLdapProxyServers
public 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
com.redback.npm.api.admin.ProxyMgmtIfc
Interface ProxyMgmtIfc
public interface ProxyMgmtIfc extends java.rmi.Remote
ProxyMgmtIfc is a web services endpoint that enables you to add, retrieve, modify, and remove proxy configuration information in the NetOp PM database.
Methods
addProxyInfo
public 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 realm InvalidLdapProxyServerException - if any of the LdapProxyServerobjects specified is not valid InvalidLicenseException - if a required license is missing InvalidProxyInfoException - if the ProxyInfoobject specified is not valid InvalidRadiusProxyServerException - if any of the RadiusProxyServerobjects specified is not valid InvalidServiceException - if an unknown service identifier is specified in the ProxyInfoobject NoAccessServiceException - if default/invalid redirect services is not an Access service or if the invalid redirect services does not have the DynamicIPAddress variation defined RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
getProxyInfo
public 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 default configuration 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 exist RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
removeProxyInfo
public 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 exist RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
updateProxyInfo
public 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 valid InvalidLicenseException - if a required license is missing InvalidProxyInfoException - if the ProxyInfoobject specified is not valid InvalidRadiusProxyServerException - if any of the RadiusProxyServerobjects specified is not valid InvalidServiceException - if an unknown service identifier is specified in the ProxyInfoobject NoAccessServiceException - if default/invalid redirect services is not an Access service or if the invalid redirect services does not have the DynamicIPAddress variation defined RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
Page 40
com.redback.npm.api.admin.ProxyServer
Class ProxyServer
java.lang.Object | +-com.redback.npm.api.admin.ProxyServer All Implemented interfaces: java.lang.Comparable Direct Known Subclasses: RadiusProxyServer, LdapProxyServer
public abstract class ProxyServer extends java.lang.Object implements java.lang.Comparable

This class represents a single server to which NPM can proxy an authentication request.
Methods
setHost
public 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
getHost
public java.lang.String getHost() Get the hostname or IP address of the Proxy server Returns: the hostname or IP Address of the proxy server
setPort
public void setPort(int port) Set the authentication port of the Proxy server Parameters: port - the authentication port number of the proxy server
getPort
public int getPort() Get the authentication port of the Proxy server Returns: the authentication port number of the proxy server
Page 41
setRetryLimit
public void setRetryLimit(int retries) Set the number of retransmission attempt to the Proxy server Parameters: retries - the number of retransmission attempt
getRetryLimit
public int getRetryLimit() Get the number of retransmission attempt to the Proxy server Returns: the number of retransmission attempt
setSequence
public 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
getSequence
public int getSequence() Get the sequence number for this server in this realm Returns: the sequence number of this server in this realm
setTimeout
public 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
getTimeout
public 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
compareTo
public 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 ProxyServer object 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 specified object's sequence number is the same as this ProxyServer's sequence number 1 if the specified object's sequence number is less than this ProxyServer's sequence number or the specified object is null
Page 43
com.redback.npm.api.admin.RadiusProxyServer
Class RadiusProxyServer
java.lang.Object | +-com.redback.npm.api.admin.ProxyServer | +-com.redback.npm.api.admin.RadiusProxyServer
public class RadiusProxyServer extends ProxyServer

This class represents a single radius server to which NPM can proxy an authentication request.
Constructors
RadiusProxyServer
public RadiusProxyServer() Default constructor
Methods
getSecret
public java.lang.String getSecret() Get the secret key Returns: the secret key
setSecret
public void setSecret(java.lang.String secret) Set the secret key Parameters: secret - the secret key
getAcctPort
public int getAcctPort() Get the accounting port number of the radius proxy server Returns: the accounting port number of the radius proxy server
setAcctPort
public 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
Package
com.redback.npm.api.auth
Page 46
com.redback.npm.api.auth.AuthenticationIfc
com.redback.npm.api.auth
Interface AuthenticationIfc
public interface AuthenticationIfc extends java.rmi.Remote
AuthenticationIfc is a web services endpoint that enables you to authenticate, log on, and log off subscribers.
Methods
authenticateSubscriber
public 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 external RADIUS server if the NetOp PM system is configured to proxy RADIUS authentication messages. Parameters: subAcctName - the name of the subscriber account to authenticate subAcctPassword - 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 occurs SQLException - if a database access error occurs VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and none of the external RADIUS servers replies to the authentication request VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and there is an error communicating with one of the external RADIUS servers VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and one of the specified external RADIUS servers is unknown VerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOp PM database VerifyException - if there is an error verifying the encoded subAcctPassword Since: 1.1.3
authenticateSubscriberSession
public 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 RADIUS authentication 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
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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and none of the external RADIUS servers replies to the authentication request VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and there is an error communicating with one of the external RADIUS servers VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and one of the specified external RADIUS servers is unknown VerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOp PM database VerifyException - if there is an error verifying the encoded subAcctPassword Since: 1.1.3
authenticateSubscriberSessionWithReply
public AuthenticationReply authenticateSubscriberSessionWithReply(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 RADIUS authentication 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 subAcctPassword - 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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and none of the external RADIUS servers replies to the authentication request VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and there is an error communicating with one of the external RADIUS servers VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and one of the specified external RADIUS servers is unknown VerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOp PM database VerifyException - if there is an error verifying the encoded subAcctPassword Since: 1.2.4
Page 48
authenticateSubscriberWithReply
public AuthenticationReply authenticateSubscriberWithReply(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 external RADIUS server if the NetOp PM system is configured to proxy RADIUS authentication messages. Parameters: subAcctName - the name of the subscriber account to authenticate subAcctPassword - 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: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and none of the external RADIUS servers replies to the authentication request VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and there is an error communicating with one of the external RADIUS servers VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and one of the specified external RADIUS servers is unknown VerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOp PM database VerifyException - if there is an error verifying the encoded subAcctPassword Since: 1.2.4
bindSubscriberToSession
public 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, it is automatically created and activated. It is assumed that the subscriber is pre- authenticated outside of the NetOp PM system. Parameters: ipAddr - the IP address of the PC on which the subscriber is being bound to subAcctName - the name of the subscriber account to bind Exceptions: InvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM system InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system. For example, the subAcctNameis empty or contains too many characters RemoteException - if an unexpected error occurs SessionAlreadyBoundException - if the session for the given IP address is already bound to another subscriber
Page 49
SessionLimitException - if the subscriber has already logged in with the maximum number of logins defined by their selected services and the services are not defined to automatically log off the oldest login. SQLException - if a database access error occurs VerifyException - if a location lock exists for the subscriber but the session is from a wrong location
bindSubscriberToSessionAndApplyServices
public 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 the session. 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 to subAcctName - the name of the subscriber account to bind Exceptions: InvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM system InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system. For example, the subAcctNameis empty or contains too many characters RemoteException - if an unexpected error occurs SessionAlreadyBoundException - if the session for the given IP address is already bound to another subscriber SessionLimitException - if the subscriber has already logged in with the maximum number of logins defined by their selected services and the services are not defined to automatically log off the oldest login. SQLException - if a database access error occurs VerifyException - if a location lock exists for the subscriber but the session is from a wrong location; if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 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).
bindSubscriberToNASUser
public 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, it is automatically created and activated. If the NAS user does not exist, it is also automatically created. It is assumed that the subscriber is pre- authenticated outside of the NetOp PM system. Parameters: nasUserName - the NAS user of the PC on which the subscriber is being bound to subAcctName - the name of the subscriber account to bind Exceptions: InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system. For example, the subAcctNameis empty or contains too many characters RemoteException - if an unexpected error occurs SessionAlreadyBoundException - if the session for any IP address of the given NAS user is already bound to another subscriber SessionLimitException - if the subscriber has already logged in with the maximum number of logins defined by their selected services and the services are not defined to automatically logoff the oldest login.
Page 50
SQLException - if a database access error occurs VerifyException - if a location lock exists for the subscriber but some session of the NAS user is from an incorrect location
bindSubscriberToNASUserAndApplyServices
public 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 the session. If the subscriber account does not exist, it is automatically created and activated. If the NAS user does not exist, it is also automatically created. Parameters: nasUser - the NAS user of the PC on which the subscriber is being bound to subAcctName - the name of the subscriber account to bind Exceptions: InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system. For example, the subAcctNameis empty or contains too many characters RemoteException - if an unexpected error occurs SessionAlreadyBoundException - if the session for any IP address of the given NAS user is already bound to another subscriber SessionLimitException - if the subscriber is already logged in with the maximum number of logins defined by their selected services, and the services are not defined to automatically log off the oldest login. SQLException - if a database access error occurs VerifyException - if a location lock exists for the subscriber but the session is from a wrong location; if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 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).
logoffNASUserName
public 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 Portal service to all subscriber sessions, if applicable). The next time the subscriber starts a web browser, the subscriber must log on 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 Captive Portal service, if applicable; false if any of the sessions could not be logged off Exceptions: InvalidNASUserException - if nasUserName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since:
Page 51
1.1.3
logoffSubSession
public 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 the subscriber session, 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 off Returns: true if the subscriber session associated with the IP address is successfully logged off and assigned the Captive Portal service, if applicable; false if the subscriber session could not be logged off Exceptions: InvalidIPAddressException - if ipAddr is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.1.3
logoffSubSessions
public 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 Portal service 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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.1.3
Page 52
logonNASUserName
public 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 successfully logged on. Parameters: nasUserName - the NAS username for the subscriber session associated with the subscriber account on successful logon subAcctName - the name of the subscriber account to authenticate subAcctPassword - 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 subscriber sessions associated with the NAS user could not be logged on Exceptions: InvalidNASUserException - if nasUserName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SessionLimitException - if the subscriber has already logged in with the maximum number of logins defined by their selected services and the services are not defined to automatically logoff the oldest login. SQLException - if a database access error occurs VerifyException - if the specified subAcctName is not valid VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and none of the external RADIUS servers replies to the authentication request VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and there is an error communicating with one of the external RADIUS servers VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and one of the external RADIUS servers is unknown VerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOp PM database VerifyException - 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 are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.1.3
logonNASUserNameWithReply
public 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 successfully logged on. Parameters: nasUserName - the NAS username for the subscriber session associated with the subscriber account on successful logon subAcctName - the name of the subscriber account to authenticate subAcctPassword - the subscriber account password used for authentication
Page 53
Returns: an Authentication Reply object that contains the result of authenticating the subscriber account name and password Exceptions: InvalidNASUserException - if nasUserName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SessionLimitException - if the subscriber has already logged in with the maximum number of logins defined by their selected services and the services are not defined to automatically logoff the oldest login. SQLException - if a database access error occurs VerifyException - if the specified subAcctName is not valid VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and none of the external RADIUS servers replies to the authentication request VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and there is an error communicating with one of the external RADIUS servers VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and one of the external RADIUS servers is unknown VerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOp PM database VerifyException - 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 are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.2.4
logonSubSession
public 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 calls authenticateSubscriberSession and, once authenticated, logs the session on, removing the Captive Portal service from the subscriber session, if applicable. Parameters: ipAddr - the IP address of the PC on which the subscriber is attempting to authenticate the subscriber account subAcctName - the name of the subscriber account to authenticate subAcctPassword - the subscriber account password used for authentication Returns: true if the subAcctName and subAcctPassword combination are successfully authenticated and the Captive Portal service is removed from the subscriber session associated with the ipAddr , if applicable; false if the subAcctName and subAcctPassword failed authentication or the Captive Portal service was not removed from the subscriber session Exceptions: InvalidIPAddressException - if ipAddr is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SessionLimitException - if the subscriber has already logged in with the maximum number of logins defined by their selected services and the services are not defined to automatically logoff the oldest login. SQLException - if a database access error occurs VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and none of the external RADIUS servers replies to the authentication request VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and there is an error communicating with one of the external RADIUS servers VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and one of the external RADIUS servers is unknown
Page 54
VerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOp PM database VerifyException - 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 are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.1.3
logonSubSessionWithReply
public 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 calls authenticateSubscriberSession and, once authenticated, logs the session on, removing the Captive Portal service from the subscriber session, if applicable. Parameters: ipAddr - the IP address of the PC on which the subscriber is attempting to authenticate the subscriber account subAcctName - the name of the subscriber account to authenticate subAcctPassword - 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 system RemoteException - if an unexpected error occurs SessionLimitException - if the subscriber has already logged in with the maximum number of logins defined by their selected services and the services are not defined to automatically logoff the oldest login. SQLException - if a database access error occurs VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and none of the external RADIUS servers replies to the authentication request VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and there is an error communicating with one of the external RADIUS servers VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and one of the external RADIUS servers is unknown VerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOp PM database VerifyException - 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 are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.2.4
nasUserNameIsLoggedOn
public 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 successfully authenticated 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 Captive Portal 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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
subAcctNameIsLoggedOn
public 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 successfully authenticated 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 the subscriber session is subscribed to the Captive Portal service Exceptions: InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
subSessionIsLoggedOn
public 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 and is 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 the subscriber session is subscribed to the Captive Portal service Exceptions: InvalidIPAddressException - if ipAddr is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database error occurs
Page 56
Since: 1.1.3
subSessionLogoff
public 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 Captive Portal service to the subscriber session, if applicable. This method verifies that the subscriber account associated with the specified subscriber session exists in the NetOp PM database, or in an external RADIUS server if the NetOp PM system is configured to proxy RADIUS authentication messages, and then applies the Captive Portal service to the subscriber session, 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 off subAcctPassword - the subscriber account password used for authentication Returns: true if the subscriber session is successfully authenticated and the subscriber session associated with the specified IP address is assigned the Captive Portal service, if applicable; false if the subscriber session could not be authenticated or the Captive Portal service was not applied Exceptions: InvalidIPAddressException - if ipAddr is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and none of the external RADIUS servers replies to the authentication request VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and there is an error communicating with one of the external RADIUS servers VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and one of the external RADIUS servers is unknown VerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOp PM database VerifyException - 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 are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.1.3
subSessionLogoffWithReply
public 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 Captive Portal service to the subscriber session, if applicable. This method verifies that the subscriber account associated with the specified subscriber session exists in the NetOp PM database, or in an external RADIUS server if the NetOp PM system is configured to proxy RADIUS authentication messages, and then applies the Captive Portal service to the subscriber session, 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 off subAcctPassword - the subscriber account password used for authentication
Page 57
Returns: AuthenticationReply 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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and none of the external RADIUS servers replies to the authentication request VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and there is an error communicating with one of the external RADIUS servers VerifyException - if the NetOp PM system is configured to proxy RADIUS authentication messages and one of the external RADIUS servers is unknown VerifyException - if there is an error encoding the specified subAcctPassword for verification in the NetOp PM database VerifyException - 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 are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.2.4
Page 58
Package
com.redback.npm.api.service
Page 59
com.redback.npm.api.service.ConfigServiceAttributeVariationTypeIfc
Interface ConfigServiceAttributeVariationTypeIfc
public interface ConfigServiceAttributeVariationTypeIfc extends java.rmi.Remote
ConfigServiceAttributeVariationTypeIfc is a web services endpoint that enables you to retrieve service attribute variation types in the NetOp PM system.
Methods
getAllServiceAttributeVariationTypesXML
public java.lang.String getAllServiceAttributeVariationTypesXML() throws java.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 Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.4.4
getServiceAttributeVariationTypeXML
public java.lang.String getServiceAttributeVariationTypeXML(java.lang.String serviceAttributeVariationTypeName) throws InvalidServiceAttributeVariationTypeException, 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 type cannot be found in the system. RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.4.4
Page 60
com.redback.npm.api.service.ServiceAttributeVariationMgmtIfc
Interface ServiceAttributeVariationMgmtIfc
public interface ServiceAttributeVariationMgmtIfc extends java.rmi.Remote
ConfigServiceAttributeVariationTypeIfc is a web services endpoint that enables you to retrieve service attribute variations in the NetOp PM system.
Methods
addServiceAttributeVariationXML
public void addServiceAttributeVariationXML(java.lang.String serviceAttributeVariationXML) throws DuplicateServiceAttributeVariationException, 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 are contained in an XML document. Parameters: serviceAttributeVariationXML - the XML representation for the new Service Attribute Variation Exceptions: DuplicateServiceAttributeVariationException - if this service attribute variation already exists in the NetOp PM database InvalidLicenseException - if not licensed for Admission Control Function InvalidServiceAttributeVariationException - if the XML representation does not pass the validation RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
updateServiceAttributeVariationXML
public void updateServiceAttributeVariationXML(java.lang.String serviceAttributeVariationXML) 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 Variation are contained in an XML document. Parameters: serviceAttributeVariationXML - the XML representation for the Service Attribute Variation Exceptions:
Page 61
InvalidLicenseException - if not licensed for Admission Control Function InvalidServiceAttributeVariationException - if the service attribute variation with the specified name cannot be found in the system RemoteException - if an unexpected error occurs ServiceAttributeVariationInUseException - if the service attribute variation with the specified name is currently in use SQLException - if a database access error occurs Since: 6.1.5
removeServiceAttributeVariation
public void removeServiceAttributeVariation(java.lang.String serviceAttributeVariationName) 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 specified name cannot be found in the system RemoteException - if an unexpected error occurs ServiceAttributeVariationInUseException - if the service attribute variation with the specified name is currently in use SQLException - if a database access error occurs Since: 6.1.5
getAllServiceAttributeVariationsXML
public 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 Variation are contained in an XML document. Returns: the XML representation of all Service Attribute Variations Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
Page 62
getServiceAttributeVariationsByTypeXML
public java.lang.String getServiceAttributeVariationsByTypeXML(java.lang.String serviceAttributeVariationType) throws InvalidServiceAttributeVariationException, java.rmi.RemoteException, java.sql.SQLException Get existing Service Attribute Variations by type from the NetOp PM database. The details of each Service Attribute Variation 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 specified type cannot be found in the system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
getServiceAttributeVariationXML
public java.lang.String getServiceAttributeVariationXML(java.lang.String serviceAttributeVariationName) throws InvalidServiceAttributeVariationException, java.rmi.RemoteException, java.sql.SQLException Get an existing Service Attribute Variation to the NetOp PM database. The details of the Service Attribute Variation are contained 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 specified name cannot be found in the system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.5
Page 63
com.redback.npm.api.service.ServiceIfc
Interface ServiceIfc
public interface ServiceIfc extends java.rmi.Remote
ServiceIfc is a web services endpoint that enables you to retrieve, apply, and remove subscriber services.
Methods
addServiceToSubAcctName
public 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 added serviceId - the internal identifier for the service to be added Exceptions: DuplicateServiceSubscriptionException - if the specified serviceId already exists in the subscriber's list of service subscriptions associated with the ipAddr IncompatibleServiceException - if the specified serviceId causes conflict with other selected services associated with the subAcctName InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - if the specified serviceId is unknown to the NetOp PM system InvalidServiceSubscriptionException - if one or more of the required override attributes are missing InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM system NoAccessServiceException - if adding the specified serviceId would leave the subscriber with no access service; that is, the first service added must be an Access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified services require a guaranteed bandwidth reservation SQLException - if a database access error occurs TooManyServicesSelectedException - if adding the specified serviceId would select too many services. UnauthorizedException - if the API user is not authorized to perform the requested task Since: 1.1.3
Page 64
addServiceToSubAcctNameXML
public 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 added serviceSubscriptionXML - the XML representation for the service subscription to be added Exceptions: DuplicateServiceSubscriptionException - if the specified serviceId already exists in the subscriber's list of service subscriptions associated with the ipAddr IncompatibleServiceException - if the specified serviceId causes conflict with other selected services associated with the subAcctName InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - if the specified serviceId is unknown to the NetOp PM system InvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or are not following a valid format InvalidServiceSubscriptionException - if one or more of the required override attributes are missing InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM system NoAccessServiceException - if adding the specified serviceId would leave the subscriber with no access service; that is, the first service added must be an Access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified services require a guaranteed bandwidth reservation SQLException - if a database access error occurs TooManyServicesSelectedException - if adding the specified serviceId would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task Since: 5.0.5
addServiceToSubSession
public 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 on serviceId - the internal identifier for the service to be added Exceptions: DuplicateServiceSubscriptionException - if the specified serviceId already exists in the subscriber's list of service subscriptions associated with the ipAddr IncompatibleServiceException - if the specified serviceId causes conflict with other selected services associated with the ipAddr InvalidIPAddressException - if ipAddr is unknown to the NetOp PM system InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - if the specified serviceId is unknown to the NetOp PM system InvalidServiceSubscriptionException - if one or more of the required override attributes are missing InvalidSubscriberAccountException - if no subscriber account is associated with the subscriber session NoAccessServiceException - if adding the specified serviceId would leave the subscriber with no access service; that is, the first service added must be an Access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot be made at the subscriber home ResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot be made in the network SQLException - if a database access error occurs TooManyServicesSelectedException - if adding the specified serviceId would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task Since: 1.1.3
addServiceToSubSessionXML
public 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 the subscriber session. Parameters: ipAddr - the IP address of the PC on which the subscriber account is logged on serviceSubscriptionXML - the XML representation for the service subscription to be added Exceptions: DuplicateServiceSubscriptionException - if the specified serviceId already exists in the subscriber's list of service subscriptions associated with the ipAddr IncompatibleServiceException - if the specified serviceId causes conflict with other selected services associated with the ipAddr InvalidIPAddressException - if ipAddr is unknown to the NetOp PM system InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - 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 be overridden in the NetOp PM system or are not following a valid format InvalidServiceSubscriptionException - if one or more of the required override attributes are missing InvalidSubscriberAccountException - if no subscriber account is associated with the subscriber session NoAccessServiceException - if adding the specified serviceId would leave the subscriber with no access service; that is, the first service added must be an Access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot be made at the subscriber home ResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot be made in the network SQLException - if a database access error occurs TooManyServicesSelectedException - if adding the specified serviceId would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task Since: 5.0.5
applyServicesToSubAcctName
public 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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.1.3
applyServicesToSubSession
public 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 system InvalidSubscriberAccountException - if no subscriber account is associated with the subscriber session RemoteException - if an unexpected error occurs SQLException - if a database access error occurs
Page 67
VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.1.3
changeAndApplyServicesToSubAcctName
public 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 instructs the 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 applied serviceIds - the array of internal identifiers for the services to be added Exceptions: DuplicateServiceSubscriptionException - if the specified serviceIds contain duplicated services IncompatibleServiceException - if the specified serviceIds contain a service identifier that causes conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to the NetOp PM system InvalidServiceSubscriptionException - if the specified serviceIds require attribute overrides InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system NoAccessServiceException - if changing the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified services require a guaranteed bandwidth reservation SessionLimitException - if the specified services allow fewer sessions than the subscriber has currently logged in and that the current services are not defined to automatically log off the old sessions SQLException - if a database access error occurs TooManyServicesSelectedException - if changing the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.1.3
Page 68
changeAndApplyServicesToSubAcctNameXML
public void changeAndApplyServicesToSubAcctNameXML(java.lang.String subAcctName, java.lang.String serviceSubscriptionsXML) throws DuplicateServiceSubscriptionException, 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 to all associated subscriber sessions. Parameters: subAcctName - the name of the subscriber account for which services are being modified and applied serviceSubscriptionsXML - the XML representation for the service subscriptions Exceptions: DuplicateServiceSubscriptionException - if the specified serviceIds contain duplicated services IncompatibleServiceException - if the specified serviceIds contain a service identifier that causes conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to the NetOp PM system InvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or are not following a valid format InvalidServiceSubscriptionException - if one or more of the required override attributes are missing InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system NoAccessServiceException - if changing the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified services require a guaranteed bandwidth reservation SessionLimitException - if the specified services allow fewer sessions than the subscriber has currently logged in and that the current services are not defined to automatically log off the old sessions SQLException - if a database access error occurs TooManyServicesSelectedException - if changing the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed; 4) if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or the value specified does not follow a valid format Since: 5.0.5
Page 69
changeAndApplyServicesToSubSession
public 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 with the 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 on serviceIds - the array of internal identifiers for the services to be added Exceptions: DuplicateServiceSubscriptionException - if the specified serviceIds contain duplicated services IncompatibleServiceException - if the specified serviceIds contain a service identifier that causes conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceSubscriptionException - if the specified serviceIds require attribute overrides InvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM system InvalidServiceException - if the specified serviceIds contain a service id that is unknown to the NetOp PM system InvalidSubscriberAccountException - if no subscriber account is associated with the subscriber session NoAccessServiceException - if changing the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot be made at the subscriber home ResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot be made in the network SessionLimitException - if the specified services allow fewer sessions than the subscriber has currently logged in and that the current services are not defined to automatically log off the old sessions SQLException - if a database access error occurs TooManyServicesSelectedException - if changing the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.1.3
Page 70
changeAndApplyServicesToSubSessionXML
public void changeAndApplyServicesToSubSessionXML(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 service subscriptions from the XML input file 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 on serviceSubscriptionsXML - the XML representation for the service subscriptions Exceptions: DuplicateServiceSubscriptionException - if the specified serviceSubscriptionsXML contains duplicated services IncompatibleServiceException - if the specified serviceIds contain a service identifier that causes conflicts InvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM system InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to the NetOp PM system InvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or are not following a valid format InvalidServiceSubscriptionException - if one or more of the required override attributes are missing InvalidSubscriberAccountException - if no subscriber account is associated with the subscriber session NoAccessServiceException - if changing the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot be made at the subscriber home ResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot be made in the network SessionLimitException - if the specified services allow fewer sessions than the subscriber has currently logged in and that the current services are not defined to automatically log off the old sessions SQLException - if a database access error occurs TooManyServicesSelectedException - if changing the specified serviceIds would select too many services VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed; 4) if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or the value specified does not follow a valid format Since: 5.0.5
Page 71
changeAndApplyWholesaleServicesToSubAcctName
public void changeAndApplyWholesaleServicesToSubAcctName(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 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 and instructs 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 applied serviceIds - the array of internal identifiers for the wholesale services to be added Exceptions: DuplicateServiceSubscriptionException - if the specified serviceIds contain duplicated services IncompatibleServiceException - if the specified serviceIds contain a service identifier that causes conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to the NetOp PM system InvalidServiceSubscriptionException - if the specified serviceIds require attribute overrides InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system NoAccessServiceException - if changing the specified serviceIds would leave the subscriber with no access service. RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified services require a guaranteed bandwidth reservation SessionLimitException - if the specified services allow fewer sessions than the subscriber has currently logged in and that the current services are not defined to automatically log off the old sessions SQLException - if a database access error occurs TooManyServicesSelectedException - if changing the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.2.4
Page 72
changeAndApplyWholesaleServicesToSubSession
public void changeAndApplyWholesaleServicesToSubSession(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 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 associated with the subscriber session and instructs the node to apply the wholesale services to all associated subscriber sessions. Parameters: ipAddr - the IP address of the PC on which the subscriber account is logged on serviceIds - the array of internal identifiers for the services to be added Exceptions: DuplicateServiceSubscriptionException - if the specified serviceIds contain duplicated services IncompatibleServiceException - if the specified serviceIds contain a service identifier that causes conflicts InvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM system InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to the NetOp PM system InvalidServiceSubscriptionException - if the specified serviceIds require attribute overrides InvalidSubscriberAccountException - if no subscriber account is associated with the subscriber session NoAccessServiceException - if changing the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot be made at the subscriber home ResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot be made in the network SessionLimitException - if the specified services allow fewer sessions than the subscriber has currently logged in and that the current services are not defined to automatically log off the old sessions SQLException - if a database access error occurs TooManyServicesSelectedException - if changing the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 1.2.4
Page 73
changeServicesForSubAcctNameXML
public 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 changed serviceSubscriptionsXML - the XML representation for the service subscriptions Exceptions: DuplicateServiceSubscriptionException - if the specified serviceSubscriptionsXML contains duplicated services IncompatibleServiceException - if the specified serviceIds contain a service identifier that causes conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to the NetOp PM system InvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or are not following a valid format InvalidServiceSubscriptionException - if one or more of the required override attributes are missing InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system NoAccessServiceException - if changing the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified services require a guaranteed bandwidth reservation SessionLimitException - if the specified services allow fewer sessions than the subscriber has currently logged in and that the current services are not defined to automatically log off the old sessions SQLException - if a database acceess error occurs TooManyServicesSelectedException - if changing the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed; 4) if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or the value specified does not follow a valid format Since: 5.0.5
Page 74
changeServicesForSubSessionXML
public 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 on serviceSubscriptionsXML - the XML representation for the service subscriptions Exceptions: DuplicateServiceSubscriptionException - if the specified serviceSubscriptionsXML contains duplicated services IncompatibleServiceException - if the specified serviceIds contain a service identifier that causes conflicts InvalidIPAddressException - if the specified ipAddr is unknown to the NetOp PM system InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature com.redback.npm.common.InvalidServiceException - if the specified serviceIds contain a service identifier that is unknown to the NetOp PM system InvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or are not following a valid format InvalidServiceSubscriptionException - if one or more of the required override attributes are missing InvalidSubscriberAccountException - if no subscriber account is associated with the subscriber session NoAccessServiceException - if changing the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot be made at the subscriber home ResourceRequestDeniedException - if the specified service's guaranteed bandwidth reservation cannot be made in the network SessionLimitException - if the specified services allow fewer sessions than the subscriber has currently logged in and that the current services are not defined to automatically log off the old sessions SQLException - if a database access error occurs TooManyServicesSelectedException - if changing the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task VerifyException - if there is an error communicating with the node when any of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed; 4) if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or the value specified does not follow a valid format Since: 5.0.5
Page 75
getAvailableServicesForSubSession
public 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 the subscriber session hosted on the specified realm, node type, circuit type, and medium type, such as NAS port type. Parameters: ipAddr - the IP address of the PC on which the subscriber account is logged on Returns: an array of ServiceListEntry objects that contain the service identifiers and service names of the retail services currently available to the specified subscriber session. Exceptions: InvalidIPAddressException - if ipAddr is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getAvailableWholesaleServicesForSubSession
public ServiceListEntry[] getAvailableWholesaleServicesForSubSession(java.lang.String ipAddr) throws InvalidIPAddressException, java.rmi.RemoteException, java.sql.SQLException Deprecated. 5.0.5 Do not use this method. Returns a list of service identifiers and service names for the wholesale services that are available to be selected by the subscriber session hosted on the specified realm, node type, circuit type, and medium type (NAS port type). Parameters: ipAddr - the IP address of the PC on which the subscriber account is logged on Returns: an array of ServiceListEntry objects that contain the service identifiers and service names of the wholesale services currently available to the specified subscriber session. Exceptions: InvalidIPAddressException - if ipAddr is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
Page 76
getMeteredTimeUsageForSubAcctName
public MeteredTimeUsage[] getMeteredTimeUsageForSubAcctName(java.lang.String subAcctName) throws InvalidSubscriberAccountException, 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 PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
getMeteredTimeUsageForSubSession
public 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 services are not supported for the specified subscriber session. Parameters: ipAddr - the IP address of the PC on which the subscriber account is logged on 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 system InvalidSubscriberAccountException - if no subscriber account is associated with the subscriber session RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
getMeteredVolumeUsageForSubAcctName
public MeteredVolumeUsage[] getMeteredVolumeUsageForSubAcctName(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException Returns a list of volume-based usage statistics for the specified subscriber account.
Page 77
Parameters: subAcctName - the name of the subscriber account Returns: an array of MeteredVolumeUsage objects containing usage statistics for the specified subscriber Exceptions: InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
getMeteredVolumeUsageForSubSession
public MeteredVolumeUsage[] getMeteredVolumeUsageForSubSession(java.lang.String ipAddr) throws InvalidIPAddressException, 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-metered services are not supported for the specified subscriber session. Parameters: ipAddr - the IP address of the PC on which the subscriber account is logged on 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 system InvalidSubscriberAccountException - if no subscriber account is associated with the subscriber session RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
getSelectedServicesForSubAcctName
public ServiceListEntry[] getSelectedServicesForSubAcctName(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException Returns a list of retail service identifiers and service names selected by the specified subscriber account. Parameters: subAcctName - the name of the subscriber account Returns: an array of ServiceListEntry objects that contain the service identifiers and service names of the retail services currently selected by the subscriber account associated with the specified subAcctName
Page 78
Exceptions: InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getSelectedServicesForSubSession
public 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 subscriber session. Parameters: ipAddr - the IP address of the PC on which the subscriber account is logged on Returns: an array of ServiceListEntry objects that contain the service identifiers and service names of the retail services currently selected by the specified subscriber session. Exceptions: InvalidIPAddressException - if ipAddr is unknown to the NetOp PM system InvalidSubscriberAccountException - if no subscriber account is associated with this subscriber session RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getSelectedWholesaleServicesForSubAcctName
public ServiceListEntry[] getSelectedWholesaleServicesForSubAcctName(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException Deprecated. 5.0.5 Do not use this method. 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 services currently selected by the subscriber account associated with the specified subAcctName Exceptions: InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs
Page 79
SQLException - if a database access error occurs Since: 1.1.3
getSelectedWholesaleServicesForSubSession
public ServiceListEntry[] getSelectedWholesaleServicesForSubSession(java.lang.String ipAddr) throws InvalidIPAddressException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException Deprecated. 5.0.5 Do not use this method. Returns a list of wholesale service identifiers and service names selected by this subscriber account associated with the subscriber session. Parameters: ipAddr - the IP address of the PC on which the subscriber account is logged on Returns: an array of ServiceListEntry objects that contain the service identifiers and service names of the wholesale services currently selected by the specified subscriber session. Exceptions: InvalidIPAddressException - if ipAddr is unknown to the NetOp PM system InvalidSubscriberAccountException - if no subscriber account is associated with this subscriber session RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getServiceOrderHistory
public 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 Exceptions: InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
Page 80
getServiceSubscriptions
public ServiceSubscription[] getServiceSubscriptions(java.lang.String subAcctName) throws InvalidSubscriberAccountException, 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 Exceptions: InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
removeAllServices
public 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 Exceptions: InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
removeAllServicesFromSubSession
public 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. 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 system InvalidSubscriberAccountException - if no subscriber account is associated with this subscriber session
Page 81
RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
removeAllWholesaleServices
public void removeAllWholesaleServices(java.lang.String subAcctName) throws InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException Deprecated. 5.0.5 Do not use this method. 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 Exceptions: InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
removeAllWholesaleServicesFromSubSession
public void removeAllWholesaleServicesFromSubSession(java.lang.String ipAddr) throws InvalidIPAddressException, InvalidSubscriberAccountException, java.rmi.RemoteException, java.sql.SQLException Deprecated. 5.0.5 Do not use this method. Removes all wholesale services selected by the subscriber account associated with this subscriber session. 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 system InvalidSubscriberAccountException - if no subscriber account is associated with this subscriber session RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
Page 82
removeService
public 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 removed serviceId - the internal identifier for the service to be removed Exceptions: InvalidServiceException - if the specified serviceId is unknown to the NetOp PM system InvalidServiceSubscriptionException - if the specified subAcctName has not subscribed to the
serviceId
InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM system NoAccessServiceException - if removing the specified serviceId would leave the subscriber with no access service RemoteException - if an unexpected error occurs SQLException - if a database access error occurs UnauthorizedException - if the API user is not authorized to perform the requested task Since: 1.1.3
removeServiceFromSubSession
public 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 subscriber session. Parameters: ipAddr - the IP address of the PC on which the subscriber account is logged on serviceId - the internal identifier for the service to be removed Exceptions: InvalidIPAddressException - if ipAddr is unknown to the NetOp PM system InvalidServiceException - if the specified serviceId is unknown to the NetOp PM system InvalidServiceSubscriptionException - if the specified ipAddr associated with this subAcctName has not subscribed to the serviceId InvalidSubscriberAccountException - if no subscriber account is associated with this subscriber session NoAccessServiceException - if removing the specified serviceId would leave the subscriber with no access service RemoteException - if an unexpected error occurs SQLException - if a database access error occurs UnauthorizedException - if the API user is not authorized to perform the requested task
Page 83
Since: 1.1.3
resetAllMeteredUsage
public 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. Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
resetMeteredUsageForNAS
public 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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
resetMeteredUsageForService
public 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 the NetOp PM database RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.0
Page 84
resetMeteredUsageForSubAcctName
public 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 Exceptions: InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
reactivateAndApplyServicesToSubAcctName
public void reactivateAndApplyServicesToSubAcctName(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 Reactivates the list of serviceIds to the specified array of serviceIds selected by the subscriber account and instructs the node to apply the services to all associated subscriber sessions. Parameters: subAcctName - the name of the subscriber account for which services are being reactivated and applied serviceIds - the array of internal identifiers for the services to be reactivated Exceptions: DuplicateServiceSubscriptionException - if the specified serviceIds contains duplicated services IncompatibleServiceException - if the specified serviceIds contain a service id that causes conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - if the specified serviceIds contain a service id that is unknown to NetOp PM System InvalidServiceSubscriptionException - if the specified serviceIds require attribute overrides InvalidServiceSubscriptionException - if the specified serviceIds is not already subscribed to by the subscriber account InvalidSubscriberAccountException - if the specified subAcctName is unknown to NetOp PM System NoAccessServiceException - if changing the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - 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 currently logged in and that the current service(s) are not defined to automatically logoff the old sessions SQLException - if a database error occurs TooManyServicesSelectedException - if changing the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task VerifyException - if there is an error communicating with the node when any of the following conditions is true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 6.1.0
reactivateAndApplyServicesToSubSession
public void reactivateAndApplyServicesToSubSession(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 the 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 on serviceIds - the array of internal identifiers for the services to be reactivated Exceptions: DuplicateServiceSubscriptionException - if the specified serviceIds contains duplicated services IncompatibleServiceException - if the specified serviceIds contain a service id that causes conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceSubscriptionException - if the specified serviceIds require attribute overrides InvalidServiceSubscriptionException - if the specified serviceIds is not already subscribed to by the subscriber account InvalidIPAddressException - if the specified ipAddr is unknown to NetOp PM System InvalidServiceException - if the specified serviceIds contain a service id that is unknown to NetOp PM System unknown to NetOp PM System InvalidSubscriberAccountException - if no subscriber account is associated with the subscriber session NoAccessServiceException - if changing the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified service(s) guaranteed bandwidth reservation can not be made at the subscriber home ResourceRequestDeniedException - if the specified service(s) guaranteed bandwidth reservation can not be made in the network SessionLimitException - if the specified service(s) allow fewer sessions than the subscriber has currently logged in and that the current service(s) are not defined to automatically logoff the old sessions SQLException - if a database error occurs TooManyServicesSelectedException - if changing the specified serviceIds would select too many services
Page 86
UnauthorizedException - if the API user is not authorized to perform the requested task VerifyException - if there is an error communicating with the node when any of the following conditions is true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 6.1.0
reactivateServicesForSubAcctName
public 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 reactivated serviceIds - the array of internal identifiers for the services to be reactivated Exceptions: DuplicateServiceSubscriptionException - if the specified serviceSubscriptionsXML contains duplicated services IncompatibleServiceException - if the specified serviceIds contain a service id that causes conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - if the specified serviceIds contain a service id that is unknown to NetOp PM System InvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to be overridden in NPM or are not following a valid format InvalidServiceSubscriptionException - if the specified serviceIds is not already subscribed to by the subscriber account InvalidSubscriberAccountException - if the specified subAcctName is unknown to NetOp PM System NoAccessServiceException - if changing the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified service(s) require a guaranteed bandwidth reservation SessionLimitException - if the specified service(s) allow fewer sessions than the subscriber has currently logged in and that the current service(s) are not defined to automatically logoff the old sessions SQLException - if a database error occurs TooManyServicesSelectedException - if changing the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task VerifyException - if there is an error communicating with the node when any of the following conditions is true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed; 4) if one or more of the specified attributes are not allowed to be overridden in NPM or the value specified does not follow a valid format Since: 6.1.0
Page 87
reactivateServicesForSubSession
public 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 the subscriber session. Parameters: ipAddr - the IP address of the PC on which the subscriber account is logged on serviceIds - the array of internal identifiers for the services to be reactivated Exceptions: DuplicateServiceSubscriptionException - if the specified serviceIds contains duplicated services IncompatibleServiceException - if the specified serviceIds contain a service id that causes conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceSubscriptionException - if the specified serviceIds require attribute overrides InvalidServiceSubscriptionException - if the specified serviceIds is not already subscribed to by the subscriber account InvalidIPAddressException - if the specified ipAddr is unknown to NetOp PM System InvalidServiceException - if the specified serviceIds contain a service id that is unknown to NetOp PM System unknown to NetOp PM System InvalidSubscriberAccountException - if no subscriber account is associated with the subscriber session NoAccessServiceException - if changing the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if the specified service(s) guaranteed bandwidth reservation can not be made at the subscriber home ResourceRequestDeniedException - if the specified service(s) guaranteed bandwidth reservation can not be made in the network SessionLimitException - if the specified service(s) allow fewer sessions than the subscriber has currently logged in and that the current service(s) are not defined to automatically logoff the old sessions SQLException - if a database error occurs TooManyServicesSelectedException - if changing the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task VerifyException - if there is an error communicating with the node when any of the following conditions is true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 6.1.0
Page 88
com.redback.npm.api.service.ServiceMgmtIfc
Interface ServiceMgmtIfc
public interface ServiceMgmtIfc extends java.rmi.Remote
ServiceMgmtIfc is a web services endpoint that enables you to create, retrieve, and delete services in the NetOp PM database.
Methods
createServiceOfferingXML
public 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 generated automatically by the NetOp PM system; any creation date value specified in the details of the ServiceOffering 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 NetOp PM system DuplicateServiceException - if the name specified in the ServiceOffering object already exists in the NetOp PM system InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidServiceException - if the id specified in the ServiceOffering object is not valid com.redback.npm.common.InvalidServiceException - if the name specified in the ServiceOffering object is not valid ProcessingFailureException - if an error occurs while processing the XML document RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
getAllServiceOfferingTypesXML
public 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 in the 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
RemoteException - if an unexpected error occurs Since: 2.0
getAllServices
public 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 of 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 services in the NetOp PM database Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getAllServicesByType
public 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 NetOp PM database Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
getAllWholesaleServices
public ServiceListEntry[] getAllWholesaleServices() throws java.rmi.RemoteException, java.sql.SQLException Deprecated. 5.0.5 Do not use this method. 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 in the NetOp PM database
Page 90
Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getAvailableRealmServices
public 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, and where 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 the NetOp PM database available to the specified realm Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getAvailableRealmWholesaleServices
public ServiceListEntry[] getAvailableRealmWholesaleServices(java.lang.String realm) throws java.rmi.RemoteException, java.sql.SQLException Deprecated. 5.0.5 Do not use this method. 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 in the NetOp PM database available to the specified realm Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getAvailableServices
public 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, and where 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 the NetOp PM database available to the default realm Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getAvailableWholesaleServices
public ServiceListEntry[] getAvailableWholesaleServices() throws java.rmi.RemoteException, java.sql.SQLException Deprecated. 5.0.5 Do not use this method. Returns a list of service identifiers and service names for all wholesale services that are available to the default realm, and where 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 in the NetOp PM database available to the default realm Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getServiceDetailsXML
public 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 in the NetOp PM database RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
Page 92
getServiceDetailsXMLForRealm
public java.lang.String getServiceDetailsXMLForRealm(java.lang.String realm, java.lang.String serviceId) throws InvalidServiceException, java.rmi.RemoteException, java.sql.SQLException Deprecated. 5.0.5 Do not use this method. Returns the details of the specified retail service for the specified realm. Parameters: realm - the name of the realm used to retrieve service details 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: InvalidServiceException - if the specified serviceId does not exist in the NetOp PM database RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.2.4
removeServiceOffering
public 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 database RemoteException - if an unexpected error occurs in the NetOp PM database ServiceInUseException - if any subscriber is subscribed to the specified serviceId SQLException - if a database access error occurs Since: 1.1.3
updateServiceOfferingXML
public 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 the NetOp PM system InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature com.redback.npm.common.InvalidServiceException - if the id specified in the ServiceOffering object does not exist in the NetOp PM database com.redback.npm.common.InvalidServiceException - if the name specified in the ServiceOffering object is not valid ProcessingFailureException - if an error occurs while processing the XML document RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
Page 94
com.redback.npm.api.service.ServiceSubscription
Class ServiceSubscription
java.lang.Object | +-com.redback.npm.api.service.ServiceSubscription
public class ServiceSubscription extends java.lang.Object

This class provides a SOAP representation of the ServiceSubscription class.
Constructors
ServiceSubscription
public ServiceSubscription()
Methods
getSubscriberAccount
public java.lang.String getSubscriberAccount() Returns the name of the subscriber account for this subscription. Returns: the subscriber account name Since: 2.0
setSubscriberAccount
public 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
getServiceId
public java.lang.String getServiceId() Returns the service identifier for this subscription. Returns: the service identifier Since: 2.0
Page 95
setServiceId
public void setServiceId(java.lang.String serviceId) Sets the service identifier for this subscription. Parameters: serviceId - the service identifier for this subscription Since: 2.0
getServiceName
public java.lang.String getServiceName() Returns the service name for this subscription. Returns: the service name for this subscription Since: 2.0
setServiceName
public void setServiceName(java.lang.String serviceName) System use only. Parameters: serviceName - the service name for this subscription Since: 2.0
isActivated
public boolean isActivated() Returns true if this subscription is active. Returns: true if this subscription is active; otherwise false Since: 2.0
setActivated
public void setActivated(boolean activated) System use only. Parameters: activated - if this subscription is active Since: 2.0
Page 96
getActivation
public 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
setActivation
public void setActivation(java.util.Calendar activation) System use only. Parameters: activation - the subscription's activation date and time Since: 2.0
getDeactivation
public 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
setDeactivation
public void setDeactivation(java.util.Calendar deactivation) System use only. Parameters: deactivation - the subscription's deactivation date and time Since: 2.0
getExpiration
public 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
setExpiration
public void setExpiration(java.util.Calendar expiration) System use only. Parameters: expiration - the subscription's expiration date and time Since: 2.0
getTimeUsed
public 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
setTimeUsed
public void setTimeUsed(MeteredTime timeUsed) System use only. Parameters: timeUsed - the amount of time that this subscription has been in use Since: 2.0
getInBytesUsed
public 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
setInBytesUsed
public 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
getOutBytesUsed
public 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
setOutBytesUsed
public 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
isQuotaExceeded
public 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
setQuotaExceeded
public void setQuotaExceeded(boolean quotaExceeded) System use only. Parameters: quotaExceeded - the quota for this subscription has been exceeded Since: 2.0
getReservationState
public 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
setReservationState
public void setReservationState(java.lang.String reservationState) System use only. Parameters: reservationState - the current reservation state of the service subscription. Since: 6.1
getOverrides
public java.util.Map getOverrides() Returns the overrides for this subscription. Returns: a list of overrides for this subscription Since: 2.0
setOverrides
public 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
com.redback.npm.api.session.SessionIP
Class SessionIP
java.lang.Object | +-com.redback.npm.api.session.SessionIP
public class SessionIP extends java.lang.Object

This class provides a SOAP representation of the SessionIP class.
Constructors
SessionIP
public SessionIP() Default constructor
Methods
getSessionId
public java.lang.String getSessionId() Returns the session name. Returns: the session name
setSessionId
public void setSessionId(java.lang.String id) Sets the session name. Parameters: id - the session name to set
getIPAddress
public java.lang.String getIPAddress() Returns the session IP address in a CIDR format. Returns: the IP address
setIPAddress
public 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.SessionMgmtIfc
Interface SessionMgmtIfc
public interface SessionMgmtIfc extends java.rmi.Remote
SessionMgmtIfc is a web services endpoint that enables you to retrieve, clear, or update subscriber sessions in the NetOp PM database.
Methods
clearSubSessionByIPAddr
public 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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs VerifyException - if there is an error communicating with the node when one or more of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 5.0.3
clearSubSessionByNASUserName
public 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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs
Page 103
VerifyException - if there is an error communicating with the node when one or more of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 5.0.3
clearSubSessionBySubAcctName
public 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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs VerifyException - if there is an error communicating with the node when one or more of the following conditions are true: 1) the NAS type is not supported; 2) the attempted SNMP operation was not found in the node's configuration file; 3) the SNMP message failed Since: 5.0.3
getKnownNodeNames
public 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 Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
getStaticIpAddresses
public 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 Exceptions: InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
getSubscriberSession
public 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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
getSubscriberSessionNames
public 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 list filter - a filter string to use on the session names in the form of a properly escaped SQL LIKE clause; for example, 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 of sessions allowed by the node (dependent on the SE model and SEOS version) Exceptions: InvalidNASException - if the specified nasId is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
Page 105
getSubscriberSessions
public 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 the subscriber account is currently logged in. Parameters: subAcctName - the subscriber account name whose active sessions you want to list Returns: an array of SubscriberSession objects Exceptions: InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
getSubscriberSessionsByNAS
public 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 system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
getSubscriberSessionSummaries
public SubscriberSessionSummary[] getSubscriberSessionSummaries(java.lang.String subAcctName) throws InvalidSubscriberAccountException, 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 Exceptions: InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
setStaticIpAddresses
public 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 in ips - the list of IP addresses to assign to this subscriber account Exceptions: InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 2.0
Page 107
Package
com.redback.npm.api.user
Page 108
com.redback.npm.api.user.NASUser
Class NASUser
java.lang.Object | +-com.redback.npm.api.user.NASUser
public class NASUser extends java.lang.Object

This class provides a SOAP representation of the NASUser class.
Constructors
NASUser
public NASUser()
Methods
getName
public java.lang.String getName() Returns the name of this NAS user. Returns: the name of this NAS user
setName
public void setName(java.lang.String nasUserName) Sets the name of this NAS User. Parameters: nasUserName - the new name for this NAS user
public java.lang.String getSubscriberAccount() Returns the name of the subscriber account associated with this NAS user. Returns: the subscriber account name associated with this NAS user
public 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
isLoggedIn
public boolean isLoggedIn() Determines whether this NAS user is logged on. Returns: true if this NAS User is logged on; otherwise false
setLoggedIn
public 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
getCreationDate
public 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
setCreationDate
public void setCreationDate(java.util.Date createdOn) System use only. Parameters: createdOn - the date and time that this NAS user record was created
getNasId
public java.lang.String getNasId() Returns the name of the node associated with this NAS user. Returns: the node identifier associated with this NAS user
setNasId
public 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.
getStaticIPAddresses
public 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
setStaticIPAddresses
public 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
getFramedRoutes
public 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
setFramedRoutes
public 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
com.redback.npm.api.user.SubscriberAccount
Class SubscriberAccount
java.lang.Object | +-com.redback.npm.api.user.SubscriberAccount
public class SubscriberAccount extends java.lang.Object

This class provides a SOAP representation of the SubscriberAccount class.
Constructors
SubscriberAccount
public SubscriberAccount()
Methods
getName
public java.lang.String getName() Returns the name of the subscriber account. Returns: the name of this subscriber account Since: 1.1
setName
public void setName(java.lang.String subAcctName) Sets the name of the subscriber account. Parameters: subAcctName - the name for this subscriber account Since: 1.1
getPassword
public java.lang.String getPassword() Returns the password for this subscriber account. Returns: the unencrypted password for this subscriber account Since: 1.1
Page 112
setPassword
public 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
getLocationLock
public java.lang.String getLocationLock() Returns the location lock for the subscriber account. Returns: the location lock for this subscriber account Since: 5.0
setLocationLock
public void setLocationLock(java.lang.String locationLock) Sets the name of the subscriber account. Parameters: locationLock - the location lock for this subscriber account Since: 5.0
isActivated
public boolean isActivated() Returns true if this subscriber account is activated. Returns: true if this subscriber account is activated; otherwise false Since: 1.1
setActivated
public 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
getCreationDate
public 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
setCreationDate
public void setCreationDate(java.util.Date date) System use only. Sets the creation date. Parameters: date - the creation date Since: 1.1
getCreditControlExternalId
public 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
setCreditControlExternalId
public 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
getCreditControlExternalType
public 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
setCreditControlExternalType
public 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
getExternalId
public java.lang.String getExternalId() Returns the external ID for this subscriber account. Returns: the external ID for this subscriber account Since: 6.1.2
setExternalId
public 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
getExternalField1
public 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
setExternalField1
public 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
getExternalField2
setExternalField2
getExternalField3
setExternalField3
getExternalField4
Page 116
setExternalField4
getExternalField5
setExternalField5
getSubscriptionIds
public 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
setSubscriptionIds
public 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
getSubscriptions
public 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
setSubscriptions
public 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
isLocal
public 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 external system Since: 2.0
setLocal
public void setLocal(boolean local) System use only. Parameters: local - indicates a locally managed account Since: 1.1
getCircuitAttributes
public 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
setCircuitAttributes
public void setCircuitAttributes(CircuitAttribute[] circuitAttributes) Set this subscriber's circuit attributes. Parameters: circuitAttributes - the array of SessionAttributeVariation objects containing circuit specific RADIUS attributes for this subscriber Since: 5.0.5
Page 118
com.redback.npm.api.user.SubscriberAccountNameList
Class SubscriberAccountNameList
java.lang.Object | +-com.redback.npm.api.user.SubscriberAccountNameList
public class SubscriberAccountNameList extends java.lang.Object

This class provides a SOAP representation of the SubscriberAccountNameList class.
Constructors
SubscriberAccountNameList
public SubscriberAccountNameList()
Methods
getMoreNamesAvailable
public 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
getNames
public 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
getNextCursor
public java.lang.String getNextCursor() Returns a string containing information relevant to the previous call. Intended to be passed as a filter parameter to the API and used only by the API to return the next set of subscriber account names, if any, resulting from a search to the caller. Only valid for use when a SubscriberAccountNameList indicates that more names are available in a forward direction; 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
getPrevCursor
public java.lang.String getPrevCursor()
Page 119
Returns a string containing information relevant to the previous call. Intended to be passed as filter parameter to the API and used only by the API to return the previous set of subscriber account names if any, resulting from a search to the caller. Only valid for use when a SubscriberAccountNameList has successfully traversed forward at least once using the getNextCursor method to provide a filter parameter or when a SubscriberAccountNameList indicates that more names are available in a backward direction after one or more subsequent API calls using this method to provide a API. Returns: a string containing API information relative to the previous call
getReturnLimit
public int getReturnLimit() Returns an integer representing the return limit for the API server through which the search was performed. The return limit 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
getStatusCode
public int getStatusCode() Returns an integer representing the status of the subscriber account name search from the API call. Valid status code values and definitions for this method are: 0 - no results exist for the submitted search filter; 1 - results exist for the submitted search filter; 2 - results exist for the submitted search filter, but the number of names requested was larger than the API server's return limit; and 3 - an invalid cursor argument was submitted; for instance, when no more rows are available Returns: an integer value representing the status of the subscriber account name search
setMoreNamesAvailable
public 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
setNames
public 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
setNextCursor
public void setNextCursor(java.lang.String nextCursor) Sets a SubscriberAccountNameList's next cursor value. Parameters: nextCursor - a string value for the next cursor
setPrevCursor
public void setPrevCursor(java.lang.String prevCursor) Sets a SubscriberAccountNameList's previous cursor value.
Page 120
Parameters: prevCursor - a string value for the previous cursor
setReturnLimit
public void setReturnLimit(int returnLimit) Sets a SubscriberAccountNameList's API server return limit value. This value indicates the maximum number of objects returned by an API server in one request. Parameters: returnLimit - an integer representing the API server return limit
setStatusCode
public 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
com.redback.npm.api.user.UserMgmtIfc
Interface UserMgmtIfc
public interface UserMgmtIfc extends java.rmi.Remote
UserMgmtIfc is a web services endpoint that enables you to add, retrieve, update, and delete subscribers in the NetOp PM database.
Methods
addNASUser
public 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 by this 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 database InvalidNASException - if the nasId specified in the nasUser object is unknown to the NetOp PM system InvalidNASUserException - if the name specified in the nasUser object is not valid InvalidSubscriberAccountException - if the subAcctName specified in the nasUser object is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
addNASUserXML
public 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 by this 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 database InvalidNASException - if the nasId specified in the nasUser object is unknown to the NetOp PM system
Page 122
InvalidNASUserException - if the name specified in the nasUser object is not valid InvalidSubscriberAccountException - if the subAcctName specified in the nasUser object is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.2.4
addSubscriberAccount
public 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 is automatically 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 the NetOp PM database Exceptions: DuplicateServiceSubscriptionException - if the specified subAcct contains duplicated services DuplicateSubscriberAccountException - if the name specified in the subAcct object already exists in the NetOp PM database IncompatibleServiceException - if the specified serviceIds contain service identifiers that cause conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidNASException - if the specified nasId is unknown to the NetOp PM system InvalidServiceException - if any of the serviceIds specified in the subAcct object are unknown to the NetOp PM system InvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or are not following a valid format InvalidServiceSubscriptionException - if one or more of the required override attributes are missing InvalidSubscriberAccountException - if the name specified in the subAcct object is not valid NoAccessServiceException - if adding the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if a service which requires a guaranteed bandwidth reservation is being added SQLException - if a database access error occurs TooManyServicesSelectedException - if adding the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task Since: 1.1.3
Page 123
addSubscriberAccountXML
public 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 is automatically 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 services DuplicateSubscriberAccountException - if the name specified in the subAcct object already exists in the NetOp PM database IncompatibleServiceException - if the specified serviceIds contain service identifiers that cause conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidNASException - if the specified nasId is unknown to the NetOp PM system com.redback.npm.common.InvalidServiceException - if any of the serviceIds specified in the subAcct object are unknown to the NetOp PM system InvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or are not following a valid format InvalidServiceSubscriptionException - if one or more of the required override attributes are missing InvalidSubscriberAccountException - if the name specified in the subAcct object is not valid NoAccessServiceException - if adding the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if a service which requires a guaranteed bandwidth reservation is being added SQLException - if a database access error occurs TooManyServicesSelectedException - if adding the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task Since: 1.2.4
getNASUser
public 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 system InvalidNASUserException - if the specified nasUserName is not valid RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getNASUsers
public 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 this subscriber account Returns: an array ofNASUser objects associated with the specified subAcctName. If there are noNASUser objects associated with the subAcctName, an empty array is returned. Exceptions: InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM system InvalidSubscriberAccountException - if the specified subAcctName is not valid RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getNASUsersXML
public 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 this subscriber account Returns: an XML representation for theNASUser objects associated with the specified subAcctName Exceptions: InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM system InvalidSubscriberAccountException - if the specified subAcctName is not valid RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.2.4
Page 125
getNASUserXML
public 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 system InvalidNASUserException - if the specified nasUserName is not valid RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.2.4
getSubAcctName
public 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. Parameters: ipAddr - the IP address of the PC on which the subscriber account is logged on Returns: the subscriber's account name Exceptions: InvalidIPAddressException - if ipAddr does not have an associated subscriber account RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.2.4.1
public 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 specified
subAcctName
Exceptions: InvalidSubscriberAccountException - if the specified subAcctName is unknown to the NetOp PM system InvalidSubscriberAccountException - if the specified subAcctName is not valid RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
getSubscriberAccountNameList
public SubscriberAccountNameList getSubscriberAccountNameList(java.lang.String filter, int numRows) throws java.rmi.RemoteException, java.sql.SQLException Returns a SubscriberAccountNameList populated with a list of subscriber account names resulting from a subscriber account name search. It uses the filter and numRows parameters to return a specified portion of a subscriber account name search. The number of names returned is less than or equal to the numRows parameter, but never exceeds the return limit of the API server where it is invoked. This method also supports the use of a SubscriberAccountNameList's getNextCursor() and getPrevCursor() methods to supply a filter argument to support forward and backward traversal of a subscriber account name search result if more than the number of names returned are available. The return limit of an API server is the maximum number of objects that can be returned by an API server in one call. If numRows is more than an API server's return limit or less than 0, this method will return a number of names less than or equal to the return limit. If numRows has a value of 0, no names will be returned, but a search will be performed and an appropriate status code will be set. Parameters: filter - the search filter for the subscriber account names supporting wildcards '*' to match any number of characters, and '?' or '.' to match a single character. To search for any of the special characters, (such as *?\.), enter a backslash (\) before the character. Also accepts valid return values from the SubscriberAccountNameList getNextCursor() and getPrevCursor() methods numRows - the maximum number of subscriber account names to be returned Returns: a SubscriberAccountNameList of subscriber account names Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs See Also: com.redback.npm.common.SubscriberAccountNameList Since: 6.0.3.2
getSubscriberAccountNames
public 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 of characters and '?' or '.' to match a single character. To search for any of the special characters(such as *?\.) enter a backslash (\) before the character. Returns: a NameList of subscriber account names Exceptions: RemoteException - if an unexpected error occurs ReturnLimitExceededException - if the number of matching rows exceeds the configured maximum return limit SQLException - if a database access error occurs Since: 2.0
getSubscriberAccountNamesByExternalId
public java.lang.String[] getSubscriberAccountNamesByExternalId(java.lang.String externalId) throws java.rmi.RemoteException, java.sql.SQLException Returns an array of subscriber account names for subscriber accounts that contain the external ID provided. The maximum number of names that will be returned is 20. If there are more than 20 subscriber accounts that meet this criterion, the first 20 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 Exceptions: RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 6.1.2
getSubscriberAccountXML
public 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 PM system InvalidSubscriberAccountException - if the specified subAcctName is not valid RemoteException - if an unexpected error occurs SQLException - if a database access error occurs
Page 128
Since: 1.2.4
removeNASUser
public 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 nasUserName InvalidNASUserException - if nasUserName is unknown to the NetOp PM system InvalidNASUserException - if the specified nasUserName is not valid RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
removeSubscriberAccount
public 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 subAcctName InvalidSubscriberAccountException - if subAcctName is unknown to the NetOp PM system InvalidSubscriberAccountException - if the specified subAcctName is not valid RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
setDefaultISPByNASUser
public 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 user name. (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 PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs
setDefaultISPBySubSession
public 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 the default realm for the session. Parameters: ipAddr - the IP address of the PC on which to set this default realm realm - the default realm to set for this IP address Exceptions: InvalidIPAddressException - if the ipAddr is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs
updateNASUser
public 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 PM database Exceptions: InvalidNASException - if the nasId specified in the nasUser object is unknown to NetOp PM system InvalidNASUserException - if the name specified in nasUser object is unknown to the NetOp PM system InvalidNASUserException - if the name specified in the nasUser object is not valid InvalidSubscriberAccountException - if the subAcctNamespecified in the nasUser object is unknown to NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.1.3
Page 130
updateNASUserXML
public 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 system InvalidNASUserException - if the name specified in nasUser object is unknown to the NetOp PM System InvalidNASUserException - if the name specified in the nasUser object is not valid InvalidSubscriberAccountException - if the subAcctName specified in the nasUser object is unknown to the NetOp PM system RemoteException - if an unexpected error occurs SQLException - if a database access error occurs Since: 1.2.4
updateSubscriberAccount
public 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 in the NetOp PM database. Exceptions: DuplicateServiceSubscriptionException - if the specified subAcct contains duplicated services IncompatibleServiceException - if the specified serviceIds contain a service identifier that causes conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidNASException - if the specified nasId is unknown to the NetOp PM system InvalidServiceException - if any service specified in the subAcct object is unknown to the NetOp PM system InvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or are not following a valid format InvalidServiceSubscriptionException - if one or more of the required override attributes are missing InvalidSubscriberAccountException - if the name specified in the subAcct object is unknown to the NetOp PM system InvalidSubscriberAccountException - if the name specified in the subAcct object is not valid
Page 131
NoAccessServiceException - if updating the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if a service which requires a guaranteed bandwidth reservation is being added SessionLimitException - if the specified services allow fewer sessions than the subscriber has currently logged in and if the current services are not defined to log off the old sessions automatically SQLException - if a database access error occurs TooManyServicesSelectedException - if updating the specified serviceIds would select too many services UnauthorizedException - if the API user is not authorized to perform the requested task Since: 1.1.3
updateSubscriberAccountXML
public 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 services IncompatibleServiceException - if the specified serviceIds contain a service identifier that causes conflicts InvalidLicenseException - if not licensed for Admission Control Function InvalidLicenseException - if not licensed for Complex Services Feature InvalidNASException - if the specified nasId is unknown to the NetOp PM system InvalidServiceException - if any service specified in the subAcct object is unknown to the NetOp PM system InvalidServiceSubscriptionException - if one or more of the specified attributes are not allowed to be overridden in the NetOp PM system or are not following a valid format InvalidServiceSubscriptionException - if one or more of the required override attributes are missing InvalidSubscriberAccountException - if the name specified in the subAcct object is unknown to the NetOp PM system InvalidSubscriberAccountException - if the name specified in the subAcct object is not valid NoAccessServiceException - if updating the specified serviceIds would leave the subscriber with no access service RemoteException - if an unexpected error occurs ResourceRequestDeniedException - if a service which requires a guaranteed bandwidth reservation is being added SessionLimitException - if the specified services allow fewer sessions than the subscriber has currently logged in and if the current services are not defined to log off the old sessions automatically SQLException - if a database access error occurs TooManyServicesSelectedException - if updating the specified serviceIds would select too many services UnauthorizedException - 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
com.redback.npm.common.ActiveSubSessionException
Class ActiveSubSessionException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.ActiveSubSessionException
public class ActiveSubSessionException extends 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 the NetOp PM database.
Constructors
ActiveSubSessionException
public ActiveSubSessionException()
ActiveSubSessionException
public ActiveSubSessionException(java.lang.String message)
Parameters: message - a detailed error message
Page 135
com.redback.npm.common.AuthenticationReply
Class AuthenticationReply
java.lang.Object | +-com.redback.npm.common.AuthenticationReply
public class AuthenticationReply extends java.lang.Object

AuthenticationReply contains any Reply-Messages from the RADIUS server and a boolean to indicate whether the user has been authenticated.
Constructors
AuthenticationReply
public AuthenticationReply()
AuthenticationReply
public AuthenticationReply(boolean value)
Parameters: value - indicates whether the user has been authenticated
AuthenticationReply
public AuthenticationReply(boolean value, java.lang.String message)
Parameters: value - indicates whether the user has been authenticated message - the reply messages from the RADIUS server
Methods
setAuthenticated
public void setAuthenticated(boolean value) Sets whether the user has been authenticated. Parameters: value - indicates whether the user has been authenticated
getAuthenticated
public 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
getReply
public java.lang.String getReply() Returns the reply messages from the RADIUS server. Returns: the reply messages from the RADIUS server
setReply
public 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.DuplicateNASException
Class DuplicateNASException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.DuplicateNASException
public class DuplicateNASException extends 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
DuplicateNASException
public DuplicateNASException()
public DuplicateNASException(java.lang.String message)
public DuplicateNASException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - a detailed error message cause - the throwable cause of the error
public DuplicateNASException(java.lang.Throwable cause)
Parameters: cause - the throwable cause of the error
Page 138
com.redback.npm.common.DuplicateNASUserException
Class DuplicateNASUserException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.DuplicateNASUserException
public class DuplicateNASUserException extends 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
DuplicateNASUserException
public DuplicateNASUserException()
public DuplicateNASUserException(java.lang.String message)
public DuplicateNASUserException(java.lang.String message, java.lang.Throwable cause)
public DuplicateNASUserException(java.lang.Throwable cause)
Page 139
com.redback.npm.common.DuplicateProxyInfoException
Class DuplicateProxyInfoException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.DuplicateProxyInfoException
public class DuplicateProxyInfoException extends 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
DuplicateProxyInfoException
public DuplicateProxyInfoException()
public DuplicateProxyInfoException(java.lang.String message)
public DuplicateProxyInfoException(java.lang.String message, java.lang.Throwable cause)
public DuplicateProxyInfoException(java.lang.Throwable cause)
Page 140
com.redback.npm.common.DuplicateServiceException
Class DuplicateServiceException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.DuplicateServiceException
public class DuplicateServiceException extends java.lang.Exception

This exception represents an error when a service offering being added contains a service identifier or name that already exists in the NetOp PM system.
Constructors
DuplicateServiceException
public DuplicateServiceException()
public DuplicateServiceException(java.lang.String message)
public DuplicateServiceException(java.lang.String message, java.lang.Throwable cause)
public DuplicateServiceException(java.lang.Throwable cause)
Page 141
com.redback.npm.common.DuplicateServiceSubscriptionException
Class DuplicateServiceSubscriptionException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.DuplicateServiceSubscriptionException
public class DuplicateServiceSubscriptionException extends java.lang.Exception

This exception represents an error when a service subscription that is being added to a subscriber account already exists in the subscriber account's list of service subscriptions.
Constructors
DuplicateServiceSubscriptionException
public DuplicateServiceSubscriptionException()
DuplicateServiceSubscriptionException
public DuplicateServiceSubscriptionException(java.lang.String message)
Page 142
com.redback.npm.common.DuplicateSubscriberAccountException
Class DuplicateSubscriberAccountException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.DuplicateSubscriberAccountException
public class DuplicateSubscriberAccountException extends java.lang.Exception

This exception represents an error when a subscriber account being added contains a name that already exists in the NetOp PM system.
Constructors
DuplicateSubscriberAccountException
public DuplicateSubscriberAccountException()
DuplicateSubscriberAccountException
public DuplicateSubscriberAccountException(java.lang.String message)
Page 143
com.redback.npm.common.IncompatibleServiceException
Class IncompatibleServiceException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.IncompatibleServiceException
public class IncompatibleServiceException extends java.lang.Exception

This exception represents an error when a selected service causes conflict with a subscriber account's list of existing service subscriptions.
Constructors
IncompatibleServiceException
public IncompatibleServiceException()
IncompatibleServiceException
public IncompatibleServiceException(java.lang.String message)
Page 144
com.redback.npm.common.InvalidIPAddressException
Class InvalidIPAddressException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidIPAddressException
public class InvalidIPAddressException extends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize the IP address associated with this subscriber's PC.
Constructors
InvalidIPAddressException
public InvalidIPAddressException()
public InvalidIPAddressException(java.lang.String message)
public InvalidIPAddressException(java.lang.String message, java.lang.Throwable cause)
public InvalidIPAddressException(java.lang.Throwable cause)
Page 145
com.redback.npm.common.InvalidNASException
Class InvalidNASException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidNASException
public class InvalidNASException extends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this NAS.
Constructors
InvalidNASException
public InvalidNASException()
InvalidNASException
public InvalidNASException(java.lang.String message)
InvalidNASException
public InvalidNASException(java.lang.String message, java.lang.Throwable cause)
InvalidNASException
public InvalidNASException(java.lang.Throwable cause)
Page 146
com.redback.npm.common.InvalidNASUserException
Class InvalidNASUserException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidNASUserException
public class InvalidNASUserException extends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this NAS user.
Constructors
InvalidNASUserException
public InvalidNASUserException()
public InvalidNASUserException(java.lang.String message)
public InvalidNASUserException(java.lang.String message, java.lang.Throwable cause)
public InvalidNASUserException(java.lang.Throwable cause)
Page 147
com.redback.npm.common.InvalidProxyInfoException
Class InvalidProxyInfoException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidProxyInfoException
public class InvalidProxyInfoException extends java.lang.Exception

This exception represents an error due to NPM being unable to recognize the configuration.
Constructors
InvalidProxyInfoException
public InvalidProxyInfoException()
public InvalidProxyInfoException(java.lang.String message)
public InvalidProxyInfoException(java.lang.String message, java.lang.Throwable cause)
public InvalidProxyInfoException(java.lang.Throwable cause)
Page 148
com.redback.npm.common.InvalidServiceException
Class InvalidServiceException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidServiceException
public class InvalidServiceException extends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this service.
Constructors
InvalidServiceException
public InvalidServiceException()
public InvalidServiceException(java.lang.String message)
public InvalidServiceException(java.lang.String message, java.lang.Throwable cause)
public InvalidServiceException(java.lang.Throwable cause)
Page 149
com.redback.npm.common.InvalidServiceSubscriptionException
Class InvalidServiceSubscriptionException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidServiceSubscriptionException
public class InvalidServiceSubscriptionException extends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this service to which this subscriber has subscribed.
Constructors
InvalidServiceSubscriptionException
public InvalidServiceSubscriptionException()
InvalidServiceSubscriptionException
public InvalidServiceSubscriptionException(java.lang.String message)
Page 150
com.redback.npm.common.InvalidSubscriberAccountException
Class InvalidSubscriberAccountException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.InvalidSubscriberAccountException
public class InvalidSubscriberAccountException extends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this subscriber account.
Constructors
InvalidSubscriberAccountException
public InvalidSubscriberAccountException()
public InvalidSubscriberAccountException(java.lang.String message)
public InvalidSubscriberAccountException(java.lang.String message, java.lang.Throwable cause)
public InvalidSubscriberAccountException(java.lang.Throwable cause)
Page 151
com.redback.npm.common.MeteredTime
Class MeteredTime
java.lang.Object | +-com.redback.npm.common.MeteredTime All Implemented interfaces: java.lang.Cloneable
public class MeteredTime extends java.lang.Object implements java.lang.Cloneable

The MeteredTime class holds the amount of time used in a metered time service subscription.
Constructors
MeteredTime
public MeteredTime() This constructor is required by our SOAP web services toolkit. It is not intended to be called by our domain code.
MeteredTime
public MeteredTime(int int int int d, h, m, s)
Parameters: d - the number of days h - the number of hours m - the number of minutes s - the number of seconds Exceptions: IllegalArgumentException - if a parameter fails validation
Methods
subtract
public static MeteredTime subtract(MeteredTime i1, MeteredTime i2) Returns the difference between two MeteredTime objects Parameters: i1 - the MeteredTime object to be subtracted from i2 - the MeteredTime object to subtract Returns:
Page 152
a MeteredTime object containing the difference
clone
public 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. Subclasses that override the clonemethod can also throw this exception to indicate that an instance cannot be cloned. See Also: Cloneable
getDays
public int getDays() Returns the number of days. Returns: the number of days
setDays
public void setDays(int d) Sets the number of days. Parameters: d - the number of days
getHours
public int getHours() Returns the number of hours. Returns: the number of hours
setHours
public 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
getMinutes
public int getMinutes() Returns the number of minutes. Returns: the number of minutes
setMinutes
public 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
getSeconds
public int getSeconds() Returns the number of seconds. Returns: the number of seconds
setSeconds
public 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
getTimeString
public java.lang.String getTimeString() Returns the time in a string format. Returns: the time in a string format
setTimeString
public 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
toString
public java.lang.String toString() Returns the time in a string format. Returns: the time in a string format
getTotalSeconds
public long getTotalSeconds() Converts and returns the total time in seconds. Returns: the total time in seconds
Page 155
com.redback.npm.common.MeteredTimeUsage
Class MeteredTimeUsage
java.lang.Object | +-com.redback.npm.common.MeteredUsage | +-com.redback.npm.common.MeteredTimeUsage
public class MeteredTimeUsage extends MeteredUsage

The MeteredTimeUsage class holds the usage of a metered time service subscription.
Constructors
MeteredTimeUsage
public MeteredTimeUsage() This constructor is required by our SOAP web services toolkit. It is not intended to be called by our domain code.
MeteredTimeUsage
public MeteredTimeUsage(ServiceSubscription subscription)
Parameters: subscription - the ServiceSubscription object
Methods
getTimeUsed
public MeteredTime getTimeUsed() Returns the amount of time used. Returns: the amount of time used
setTimeUsed
public void setTimeUsed(MeteredTime used) Sets the amount of time used. Parameters: used - the amount of time used
getTimeLimit
public MeteredTime getTimeLimit() Returns the time limit. Returns:
Page 156
com.redback.npm.common.MeteredTimeUsage
the time limit
setTimeLimit
public void setTimeLimit(MeteredTime limit) Sets the time limit. Parameters: limit - the time limit
getTimeRemaining
public MeteredTime getTimeRemaining() Returns the time remaining before the time limit is reached. Returns: the time remaining
setTimeRemaining
public void setTimeRemaining(MeteredTime remaining) Unsupported Operation. Parameters: remaining - the amount of time remaining; you cannot set the time as it is done internally
Page 157
com.redback.npm.common.MeteredUsage
Class MeteredUsage
java.lang.Object | +-com.redback.npm.common.MeteredUsage Direct Known Subclasses: MeteredVolumeUsage, MeteredTimeUsage
public abstract class MeteredUsage extends java.lang.Object

The MeteredUsage class holds the usage of a metered service subscription.
Constructors
MeteredUsage
public MeteredUsage() This constructor is required by our SOAP web services toolkit. It is not intended to be called by our domain code.
MeteredUsage
public MeteredUsage(ServiceSubscription subscription)
Methods
getServiceId
public java.lang.String getServiceId() Returns the service identifier. Returns: the service identifier
setServiceId
public void setServiceId(java.lang.String id) Unsupported Operation. Parameters: id - the service identifier; you cannot set this as it is done internally
getServiceName
public java.lang.String getServiceName() Gets the service name.
Page 158
com.redback.npm.common.MeteredUsage
Returns: the service name
setServiceName
public void setServiceName(java.lang.String name) Unsupported Operation. Parameters: name - the service name; you cannot set this as it is done internally
Page 159
com.redback.npm.common.MeteredVolumeUsage
Class MeteredVolumeUsage
java.lang.Object | +-com.redback.npm.common.MeteredUsage | +-com.redback.npm.common.MeteredVolumeUsage
public class MeteredVolumeUsage extends MeteredUsage

The MeteredVolumeUsage class holds the usage of a metered volume service subscription.
Constructors
MeteredVolumeUsage
public MeteredVolumeUsage() This constructor is required by our SOAP web services toolkit. It is not intended to be called by our domain code.
MeteredVolumeUsage
public MeteredVolumeUsage(long inBytesRemaining, long outBytesRemaining) Constructor Parameters: inBytesRemaining - In bytes remaining outBytesRemaining - Out bytes remaining
MeteredVolumeUsage
public MeteredVolumeUsage(ServiceSubscription subscription)
Methods
getInBytesUsed
public long getInBytesUsed() Returns the number of bytes uploaded. Returns: the number of bytes uploaded
setInBytesUsed
public void setInBytesUsed(long used) Sets the number of bytes uploaded.
Page 160
Parameters: used - the number of bytes uploaded
getInBytesLimit
public long getInBytesLimit() Returns the upload limit. Returns: the upload limit
setInBytesLimit
public void setInBytesLimit(long limit) Sets the upload limit. Parameters: limit - the upload limit
getInBytesRemaining
public long getInBytesRemaining() Returns the number of upload bytes remaining before the quota is exceeded. Returns: the number of upload bytes remaining
getInKiloBytesRemaining
public long getInKiloBytesRemaining() Returns the number of upload kilobytes remaining before the quota is exceeded. Returns: the number of upload kilobytes remaining
setInBytesRemaining
public void setInBytesRemaining(long remaining) Unsupported operation. Parameters: remaining - the number of upload bytes remaining; you cannot set this as it is done internally
getOutBytesUsed
public long getOutBytesUsed() Returns the number of bytes downloaded. Returns: the number of bytes downloaded
setOutBytesUsed
public void setOutBytesUsed(long used)
Page 161
Sets the number of bytes downloaded. Parameters: used - the number of bytes downloaded
getOutBytesLimit
public long getOutBytesLimit() Returns the download limit. Returns: the download limit
setOutBytesLimit
public void setOutBytesLimit(long limit) Sets the download limit. Parameters: limit - the download limit
getOutBytesRemaining
public long getOutBytesRemaining() Returns the number of download bytes remaining before the quota is exceeded. Returns: the number of download bytes remaining
getOutKiloBytesRemaining
public long getOutKiloBytesRemaining() Returns the number of download kilobytes remaining before the quota is exceeded. Returns: the number of download kilobytes remaining
setOutBytesRemaining
public 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
com.redback.npm.common.NameList
Class NameList
java.lang.Object | +-com.redback.npm.common.NameList
public class NameList extends 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 could have been returned. That number may be greater than the number of items in the list if the configurable maximum was reached.
Constructors
NameList
public NameList()
NameList
public NameList(java.lang.String[] nameList, int count)
Parameters: nameList - an array of the names count - the total number of names that could be retrieved
Methods
getNumFound
public int getNumFound() Returns the number of items that satisfied the request that created this NameList. This value may be greater than the number of items returned in the list. Returns: the number of items that satisfied the request
setNumFound
public 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 of items returned in the list. Parameters: found - the number of items that satisfied the request
Page 163
com.redback.npm.common.NameList
getNameList
public java.lang.String[] getNameList() Returns the list of names. Returns: an array of the names
setNameList
public void setNameList(java.lang.String[] nameList) Sets the list of names. This new list replaces any existing list. Parameters: nameList - an array of names
equals
public boolean equals(java.lang.Object o)
hashCode
public int hashCode()
Page 164
com.redback.npm.common.NASInUseException
Class NASInUseException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.NASInUseException
public class NASInUseException extends 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 PM system.
Constructors
NASInUseException
public NASInUseException()
NASInUseException
public NASInUseException(java.lang.String message)
NASInUseException
public NASInUseException(java.lang.String message, java.lang.Throwable cause)
NASInUseException
public NASInUseException(java.lang.Throwable cause)
Page 165
com.redback.npm.common.NoAccessServiceException
Class NoAccessServiceException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.NoAccessServiceException
public class NoAccessServiceException extends java.lang.Exception

This exception represents an error when the subscriber has no access service subscribed.
Constructors
NoAccessServiceException
public NoAccessServiceException()
NoAccessServiceException
public NoAccessServiceException(java.lang.String message)
Page 166
com.redback.npm.common.ProcessingFailureException
Class ProcessingFailureException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.ProcessingFailureException
public class ProcessingFailureException extends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize the service.
Constructors
ProcessingFailureException
public ProcessingFailureException()
public ProcessingFailureException(java.lang.String message)
public ProcessingFailureException(java.lang.String message, java.lang.Throwable cause)
public ProcessingFailureException(java.lang.Throwable cause)
Page 167
com.redback.npm.common.ReturnLimitExceededException
Class ReturnLimitExceededException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.ReturnLimitExceededException
public class ReturnLimitExceededException extends java.lang.Exception

This exception represents an error when the number of matching rows for a query exceeds the configured maximum return limit.
Constructors
ReturnLimitExceededException
public ReturnLimitExceededException()
public ReturnLimitExceededException(java.lang.String message)
public ReturnLimitExceededException(java.lang.String message, java.lang.Throwable cause)
public ReturnLimitExceededException(java.lang.Throwable cause)
Page 168
com.redback.npm.common.ServiceInUseException
Class ServiceInUseException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.ServiceInUseException
public class ServiceInUseException extends 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
ServiceInUseException
public ServiceInUseException()
public ServiceInUseException(java.lang.String message)
public ServiceInUseException(java.lang.String message, java.lang.Throwable cause)
public ServiceInUseException(java.lang.Throwable cause)
Page 169
com.redback.npm.common.ServiceListEntry
Class ServiceListEntry
java.lang.Object | +-com.redback.npm.common.ServiceListEntry
public class ServiceListEntry extends java.lang.Object

This class wraps a service offering and represents an entry in the service list.
Constructors
ServiceListEntry
public ServiceListEntry() This constructor is required by our SOAP web services toolkit. It is not intended to be called by our domain code.
ServiceListEntry
public ServiceListEntry(ServiceOffering offering)
Parameters: offering - the ServiceOffering object
ServiceListEntry
public ServiceListEntry(ServiceSubscription subscription)
Methods
getServiceId
public java.lang.String getServiceId() Returns the service identifier associated with this service. Returns: the service identifier for this service Since: 1.1
setServiceId
public void setServiceId(java.lang.String serviceId)
Page 170
This method is implemented solely for the purpose of generating the proper web services definition for this object. It should never be called. Parameters: serviceId - the service identifier for this service Since: 1.1
getServiceName
public java.lang.String getServiceName() Returns the name of this service. Returns: the name of this service Since: 1.1
getOffering
public ServiceOffering getOffering() Returns the service offering for this service. Returns: the ServiceOffering object Since: 5.0
setServiceName
public void setServiceName(java.lang.String serviceName) This method is implemented solely for the purpose of generating the proper web services definition for this object. It should never be called. Parameters: serviceName - the name of this service Since: 1.1
equals
public 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
hashCode
public 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 is important that the same members being used to determine equivalency are also used to determine the service entry's hash code. Returns: the hash code value for the service entry
Page 172
com.redback.npm.common.ServiceOrder
Class ServiceOrder
java.lang.Object | +-com.redback.npm.common.ServiceOrder
public class ServiceOrder extends java.lang.Object

This class represents an entry in the service order history table.
Fields
ADD_ACTION
public static final java.lang.String ADD_ACTION
REMOVE_ACTION
public static final java.lang.String REMOVE_ACTION
Constructors
ServiceOrder
public ServiceOrder()
Methods
getSubAcct
public java.lang.String getSubAcct() Returns the subscriber account. Returns: the subscriber account name
setSubAcct
public void setSubAcct(java.lang.String sub) Sets the subscriber account name. Parameters: sub - the subscriber account name
Page 173
getServiceId
public java.lang.String getServiceId() Returns the service identifier for this order. Returns: the service identifier
setServiceId
public void setServiceId(java.lang.String service) Sets the service identifier for this order. Parameters: service - the service identifier
getServiceName
public java.lang.String getServiceName() Returns the service name for this order. Returns: the service name
setServiceName
public void setServiceName(java.lang.String service) Sets the service name for this order. Parameters: service - the service name
getDateTime
public 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
setDateTime
public 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
getAction
public 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 service order entry
Page 174
setAction
public 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 this service order entry. Exceptions: IllegalArgumentException - if the act parameter is not either "add" or "remove"
Page 175
com.redback.npm.common.SessionAlreadyBoundException
Class SessionAlreadyBoundException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.SessionAlreadyBoundException
public class SessionAlreadyBoundException extends java.lang.Exception

This exception represents an error if the session you are attempting to bind to a pre-authenticated subscriber is already bound to another subscriber.
Constructors
SessionAlreadyBoundException
public SessionAlreadyBoundException()
SessionAlreadyBoundException
public SessionAlreadyBoundException(java.lang.String message)
Parameters: message - the error message
Page 176
com.redback.npm.common.SessionLimitException
Class SessionLimitException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.SessionLimitException
public class SessionLimitException extends java.lang.Exception

This exception represents an error due to an attempt by a subscriber account to exceed the maximum number of logins defined by the subscriber account's service subscriptions.
Constructors
SessionLimitException
public SessionLimitException()
public SessionLimitException(java.lang.String message)
public SessionLimitException(java.lang.String message, java.lang.Exception exception)
Parameters: message - a detailed error message exception - the cause of this exception
Page 177
com.redback.npm.common.SubscriberAccountNameList
Class SubscriberAccountNameList
java.lang.Object | +-com.redback.npm.common.SubscriberAccountNameList
public class SubscriberAccountNameList extends 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 provides methods 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 API server 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 can be 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
SubscriberAccountNameList
public 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
getMoreNamesAvailable
public 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
getNames
public 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
getNextCursor
public java.lang.String getNextCursor() Returns a string containing information relevant to the previous call. It is intended to be passed as a filter parameter to the API and used only by the API to return the next set of subscriber account names, if any, that result from a search to the caller. Only valid for use when a SubscriberAccountNameList indicates that more names are available in a forward direction; 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
getPrevCursor
public java.lang.String getPrevCursor() Returns a string containing information relevant to the previous call. It is intended to be passed as a filter parameter to the API and used only by the API to return the previous set of subscriber account names, if any, that result from a search to the caller. Only valid for use when a SubscriberAccountNameList has successfully traversed forward at least once using the getNextCursor method to provide a filter parameter, or when a SubscriberAccountNameList indicates that more names are available in a backward direction, after one or more subsequent API calls using this method to provide an API. Returns: a string containing API information relative to the previous call
getReturnLimit
public int getReturnLimit() Returns an integer representing the return limit for the API server through which the search was performed. The return limit 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
getStatusCodeOrdinal
public 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
getStatusCode
public 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.StatusCode
Class SubscriberAccountNameList.StatusCode
java.lang.Object | +-java.lang.Enum | +-com.redback.npm.common.SubscriberAccountNameList.StatusCode
public static final class SubscriberAccountNameList.StatusCode extends 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 was larger 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_RESULTS
public static final com.redback.npm.common.SubscriberAccountNameList.StatusCode NO_RESULTS
RESULTS_FOUND
public static final com.redback.npm.common.SubscriberAccountNameList.StatusCode RESULTS_FOUND
SIZE_GREATER_THAN_RETURN_LIMIT
public static final com.redback.npm.common.SubscriberAccountNameList.StatusCode SIZE_GREATER_THAN_RETURN_LIMIT
INVALID_CUSOR_ARG
public static final com.redback.npm.common.SubscriberAccountNameList.StatusCode INVALID_CUSOR_ARG
Methods
Page 180
com.redback.npm.common.SubscriberAccountNameList.StatusCode
values
public static SubscriberAccountNameList.StatusCode[] values()
valueOf
public static SubscriberAccountNameList.StatusCode valueOf(java.lang.String name)
Page 181
com.redback.npm.common.SubscriberSession
Class SubscriberSession
java.lang.Object | +-com.redback.npm.common.SubscriberSessionSummary | +-com.redback.npm.common.SubscriberSession
public class SubscriberSession extends SubscriberSessionSummary

This class represents a subscriber session in the NetOp PM database.
Constructors
SubscriberSession
public SubscriberSession()
Methods
getNASPortType
public java.lang.String getNASPortType() Returns the NAS port type for this session. Returns: the NAS port type for this session
setNASPortType
public void setNASPortType(java.lang.String type) Sets the NAS port type for this session. Parameters: type - the NAS port type
getMedium
public java.lang.String getMedium() Returns the network medium for this session. Returns: the network medium
setMedium
public void setMedium(java.lang.String med) Sets the network medium for this session. Parameters:
Page 182
med - the network medium
getSessionIp
public java.lang.String getSessionIp() Returns the IP address for this session. Returns: the IP address
setSessionIp
public void setSessionIp(java.lang.String ip) Sets the IP address for this session. Parameters: ip - the IP address
public java.lang.String getSubscriberAccount() Returns the subscriber account name for this session. Returns: the subscriber account name
public void setSubscriberAccount(java.lang.String acct) Sets the subscriber account name for this session. Parameters: acct - the subscriber account name
getAcctSessionId
public java.lang.String getAcctSessionId() Returns the accounting session identifier for this session. Returns: the accounting session identifier
setAcctSessionId
public void setAcctSessionId(java.lang.String acctSessionId) Sets the accounting session ID for this session. Parameters: acctSessionId - the string accounting session identifier
getContext
public java.lang.String getContext() Returns the context for this session.
Page 183
Returns: the context
setContext
public void setContext(java.lang.String context) Sets the context for this session. Parameters: context - the context within the node
getMacAddress
public java.lang.String getMacAddress() Returns the circuit MAC address for this session. Returns: the MAC address
setMacAddress
public void setMacAddress(java.lang.String macAddr) Sets the circuit MAC address for this session. Parameters: macAddr - the MAC address
getNASPortId
public java.lang.String getNASPortId() Returns the NAS port identifier for this session. Returns: the NAS port identifier
setNASPortId
public void setNASPortId(java.lang.String nasPortId) Sets the NAS port identifier for this session. Parameters: nasPortId - the NAS port identifier
getCallingStationId
public java.lang.String getCallingStationId() Returns the calling station identifier for this session. Returns: the calling station identifier
setCallingStationId
public void setCallingStationId(java.lang.String callingStationId) Sets the calling station identifier for this session.
Page 184
Parameters: callingStationId - the calling station identifier
Page 185
com.redback.npm.common.SubscriberSessionSummary
Class SubscriberSessionSummary
java.lang.Object | +-com.redback.npm.common.SubscriberSessionSummary Direct Known Subclasses: SubscriberSession
public class SubscriberSessionSummary extends java.lang.Object

This class holds a summary of a subscriber session.
Constructors
SubscriberSessionSummary
public SubscriberSessionSummary()
Methods
getSessionId
public java.lang.String getSessionId() Returns the session identifier. Returns: the session identifier
setSessionId
public void setSessionId(java.lang.String id) Sets the session identifier. Parameters: id - the session identifier to set
getStartTime
public java.util.Date getStartTime() Returns the start time for this session. Returns: the start time
setStartTime
public 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
getNasId
public java.lang.String getNasId() Returns the NAS identifier for this session. Returns: the NAS identifier
setNasId
public void setNasId(java.lang.String id) Sets the NAS identifier for this session. Parameters: id - the NAS identifier to set
getNasType
public java.lang.String getNasType() Returns the NAS type for this session. Returns: the NAS type
setNasType
public void setNasType(java.lang.String type) Sets the NAS type for this session. Parameters: type - the NAS type to set
getCircuitType
public java.lang.String getCircuitType() Returns the circuit type for this session. Returns: the circuit type
setCircuitType
public 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.TooManyServicesSelectedException
Class TooManyServicesSelectedException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.TooManyServicesSelectedException
public class TooManyServicesSelectedException extends java.lang.Exception

This exception represents an error due to an attempt by a subscriber account to select too many service subscriptions. Currently no more than 4 service subscriptions are allowed.
Constructors
TooManyServicesSelectedException
public TooManyServicesSelectedException()
TooManyServicesSelectedException
public TooManyServicesSelectedException(java.lang.String message)
Parameters: message - a detailed error message indicating too many services have been selected
Page 188
Package
com.redback.npm.common.definition
Page 189
com.redback.npm.common.definition.AttributeInUseException
Class AttributeInUseException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.AttributeInUseException
public class AttributeInUseException extends 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 an attribute definition that is still being used in the NetOp PM database.
Constructors
AttributeInUseException
public AttributeInUseException()
public AttributeInUseException(java.lang.String message)
public AttributeInUseException(java.lang.String message, java.lang.Throwable cause)
public AttributeInUseException(java.lang.Throwable cause)
Page 190
com.redback.npm.common.definition.DuplicateAttributeException
Class DuplicateAttributeException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.DuplicateAttributeException
public class DuplicateAttributeException extends java.lang.Exception

This exception represents an error when an attribute definition being added contains a name, database column, or attribute number that already exists in the NetOp PM system.
Constructors
DuplicateAttributeException
public DuplicateAttributeException()
public DuplicateAttributeException(java.lang.String message)
Parameters: message - an error message that indicates an error was encountered
public DuplicateAttributeException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message that indicates an error was encountered cause - the throwable cause of the error
public DuplicateAttributeException(java.lang.Throwable cause)
Page 191
com.redback.npm.common.definition.DuplicateDBColumnException
Class DuplicateDBColumnException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.DuplicateDBColumnException
public class DuplicateDBColumnException extends java.lang.Exception

This exception represents an error when a RADIUS attribute definition being added contains a database column that already exists in either the accounting table or the radius_attribute database table of the NetOp PM system.
Constructors
DuplicateDBColumnException
public DuplicateDBColumnException()
public DuplicateDBColumnException(java.lang.String message)
Parameters: message - an error message indicating a duplicate database column exists
public DuplicateDBColumnException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message indicating a duplicate database column exists cause - the throwable cause of the error
public DuplicateDBColumnException(java.lang.Throwable cause)
Page 192
com.redback.npm.common.definition.DuplicateNASTypeException
Class DuplicateNASTypeException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.DuplicateNASTypeException
public class DuplicateNASTypeException extends java.lang.Exception

This exception represents an error when a NAS type being added already exists in the NetOp PM system.
Constructors
DuplicateNASTypeException
public DuplicateNASTypeException()
public DuplicateNASTypeException(java.lang.String message)
Parameters: message - an error message indicating this NAS type already exists
public DuplicateNASTypeException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message indicating this NAS type already exists cause - the throwable cause of the error
public DuplicateNASTypeException(java.lang.Throwable cause)
Page 193
com.redback.npm.common.definition.DuplicateRADIUSAttributeException
Class DuplicateRADIUSAttributeException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.DuplicateRADIUSAttributeException
public class DuplicateRADIUSAttributeException extends java.lang.Exception

This exception represents an error when a RADIUS attribute definition being added contains a name, database column, or attribute number that already exists in the NetOp PM system.
Constructors
DuplicateRADIUSAttributeException
public DuplicateRADIUSAttributeException()
public DuplicateRADIUSAttributeException(java.lang.String message)
Parameters: message - an error message that indicates an error was encountered
public DuplicateRADIUSAttributeException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message that indicates an error was encountered cause - the throwable cause of the error
public DuplicateRADIUSAttributeException(java.lang.Throwable cause)
Page 194
com.redback.npm.common.definition.InvalidAttributeException
Class InvalidAttributeException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.InvalidAttributeException
public class InvalidAttributeException extends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the attribute definition.
Constructors
InvalidAttributeException
public InvalidAttributeException()
public InvalidAttributeException(java.lang.String message)
Parameters: message - an error message that indicates the attribute definition is unrecognizable
public InvalidAttributeException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message that indicates the attribute definition is unrecognizable cause - the throwable cause of the error
public InvalidAttributeException(java.lang.Throwable cause)
Page 195
com.redback.npm.common.definition.InvalidNASTypeException
Class InvalidNASTypeException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.InvalidNASTypeException
public class InvalidNASTypeException extends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the NAS type definition.
Constructors
InvalidNASTypeException
public InvalidNASTypeException()
public InvalidNASTypeException(java.lang.String message)
Parameters: message - an error message that indicates this NAS type definition is unrecognizable
public InvalidNASTypeException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message that indicates this NAS type definition is unrecognizable cause - the throwable cause of the error
public InvalidNASTypeException(java.lang.Throwable cause)
Page 196
com.redback.npm.common.definition.InvalidRADIUSAttributeException
Class InvalidRADIUSAttributeException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.InvalidRADIUSAttributeException
public class InvalidRADIUSAttributeException extends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the RADIUS attribute definition.
Constructors
InvalidRADIUSAttributeException
public InvalidRADIUSAttributeException()
public InvalidRADIUSAttributeException(java.lang.String message)
Parameters: message - an error message that indicates the RADIUS attribute definition is unrecognizable
public InvalidRADIUSAttributeException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message that indicates the RADIUS attribute definition is unrecognizable cause - the throwable cause of the error
public InvalidRADIUSAttributeException(java.lang.Throwable cause)
Page 197
com.redback.npm.common.definition.NASTypeInUseException
Class NASTypeInUseException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.NASTypeInUseException
public class NASTypeInUseException extends 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 the NetOp PM system.
Constructors
NASTypeInUseException
public NASTypeInUseException()
public 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
public 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 use cause - the throwable cause of the error
public NASTypeInUseException(java.lang.Throwable cause)
Page 198
com.redback.npm.common.definition.RADIUSAttributeInUseException
Class RADIUSAttributeInUseException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.RADIUSAttributeInUseException
public class RADIUSAttributeInUseException extends 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 in a RADIUS attribute definition that is still being used in the NetOp PM database.
Constructors
RADIUSAttributeInUseException
public RADIUSAttributeInUseException()
public RADIUSAttributeInUseException(java.lang.String message)
public RADIUSAttributeInUseException(java.lang.String message, java.lang.Throwable cause)
public RADIUSAttributeInUseException(java.lang.Throwable cause)
Page 199
com.redback.npm.common.definition.UnmodifiableAttributeException
Class UnmodifiableAttributeException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.UnmodifiableAttributeException
public class UnmodifiableAttributeException extends 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
UnmodifiableAttributeException
public UnmodifiableAttributeException()
public UnmodifiableAttributeException(java.lang.String message)
public UnmodifiableAttributeException(java.lang.String message, java.lang.Throwable cause)
public UnmodifiableAttributeException(java.lang.Throwable cause)
Page 200
com.redback.npm.common.definition.UnmodifiableRADIUSAttributeException
Class UnmodifiableRADIUSAttributeException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.UnmodifiableRADIUSAttributeException
public class UnmodifiableRADIUSAttributeException extends java.lang.Exception

This exception represents an error due to an attempt that was made to modify an unmodifiable field in a RADIUS attribute definition.
Constructors
UnmodifiableRADIUSAttributeException
public UnmodifiableRADIUSAttributeException()
public UnmodifiableRADIUSAttributeException(java.lang.String message)
public UnmodifiableRADIUSAttributeException(java.lang.String message, java.lang.Throwable cause)
public UnmodifiableRADIUSAttributeException(java.lang.Throwable cause)
Page 201
Package
com.redback.npm.common.definition.di ameter
Page 202
com.redback.npm.common.definition.diameter.DiameterPeerTypeInUseException
com.redback.npm.common.definition.diameter
Class DiameterPeerTypeInUseException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.diameter.DiameterPeerTypeInUseException
public class DiameterPeerTypeInUseException extends java.lang.Exception

This exception represents an error due to an attempt that was made to remove or or update a DiameterPeerType which is still being used in the NetOp PM system.
Constructors
DiameterPeerTypeInUseException
public DiameterPeerTypeInUseException()
public 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
public 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 use cause - the throwable cause of the error
public DiameterPeerTypeInUseException(java.lang.Throwable cause)
Page 203
com.redback.npm.common.definition.diameter.DuplicateDiameterPeerTypeException
Class DuplicateDiameterPeerTypeException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +com.redback.npm.common.definition.diameter.DuplicateDiameterPeerTypeException
public class DuplicateDiameterPeerTypeException extends java.lang.Exception

This exception represents an error when a diameter peer type being added already exists in the NetOp PM system.
Constructors
DuplicateDiameterPeerTypeException
public DuplicateDiameterPeerTypeException()
public DuplicateDiameterPeerTypeException(java.lang.String message)
Parameters: message - an error message indicating this NAS type already exists
public DuplicateDiameterPeerTypeException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message indicating this NAS type already exists cause - the throwable cause of the error
public DuplicateDiameterPeerTypeException(java.lang.Throwable cause)
Page 204
com.redback.npm.common.definition.diameter.InvalidDiameterPeerTypeException
Class InvalidDiameterPeerTypeException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.definition.diameter.InvalidDiameterPeerTypeException
public class InvalidDiameterPeerTypeException extends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the diameter peer type definition.
Constructors
InvalidDiameterPeerTypeException
public InvalidDiameterPeerTypeException()
public InvalidDiameterPeerTypeException(java.lang.String message)
Parameters: message - an error message that indicates this Credit Control Server type definition is unrecognizable
public InvalidDiameterPeerTypeException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message that indicates this Credit Control Server type definition is unrecognizable cause - the throwable cause of the error
public InvalidDiameterPeerTypeException(java.lang.Throwable cause)
Page 205
Package
com.redback.npm.common.diameter
Page 206
com.redback.npm.common.diameter.DiameterRequestVariationInUseException
Class DiameterRequestVariationInUseException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.diameter.DiameterRequestVariationInUseException
public class DiameterRequestVariationInUseException extends java.lang.Exception

This exception represents an error due to an attempt that was made to remove or update a DiameterRequestVariationwhich is still being used in the NetOp PM system.
Constructors
DiameterRequestVariationInUseException
public DiameterRequestVariationInUseException()
public DiameterRequestVariationInUseException(java.lang.String message)
Parameters: message - an error message that indicates you tried to remove this diameter request variation when it was already in use
public 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 already in use cause - the throwable cause of the error
public DiameterRequestVariationInUseException(java.lang.Throwable cause)
Page 207
com.redback.npm.common.diameter.DuplicateDiameterPeerException
Class DuplicateDiameterPeerException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.diameter.DuplicateDiameterPeerException
public class DuplicateDiameterPeerException extends 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
DuplicateDiameterPeerException
public DuplicateDiameterPeerException()
public DuplicateDiameterPeerException(java.lang.String message)
public DuplicateDiameterPeerException(java.lang.String message, java.lang.Throwable cause)
public DuplicateDiameterPeerException(java.lang.Throwable cause)
Page 208
com.redback.npm.common.diameter.DuplicateDiameterRequestVariationException
Class DuplicateDiameterRequestVariationException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.diameter.DuplicateDiameterRequestVariationException
public class DuplicateDiameterRequestVariationException extends java.lang.Exception

This exception represents an error when a diameter request variation being added already exists in the NetOp PM system.
Constructors
DuplicateDiameterRequestVariationException
public DuplicateDiameterRequestVariationException()
public DuplicateDiameterRequestVariationException(java.lang.String message)
Parameters: message - an error message indicating this diameter request variation already exists
public DuplicateDiameterRequestVariationException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message indicating this diameter request variation already exists cause - the throwable cause of the error
public DuplicateDiameterRequestVariationException(java.lang.Throwable cause)
Page 209
com.redback.npm.common.diameter.InvalidDiameterPeerException
Class InvalidDiameterPeerException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.diameter.InvalidDiameterPeerException
public class InvalidDiameterPeerException extends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this Diameter Peer.
Constructors
InvalidDiameterPeerException
public InvalidDiameterPeerException()
public InvalidDiameterPeerException(java.lang.String message)
public InvalidDiameterPeerException(java.lang.String message, java.lang.Throwable cause)
public InvalidDiameterPeerException(java.lang.Throwable cause)
Page 210
com.redback.npm.common.diameter.InvalidDiameterRequestVariationException
Class InvalidDiameterRequestVariationException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.diameter.InvalidDiameterRequestVariationException
public class InvalidDiameterRequestVariationException extends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the diameter request variation.
Constructors
InvalidDiameterRequestVariationException
public InvalidDiameterRequestVariationException()
public InvalidDiameterRequestVariationException(java.lang.String message)
Parameters: message - an error message that indicates this diameter request variation is unrecognizable
public InvalidDiameterRequestVariationException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message that indicates this diameter request variation is unrecognizable cause - the throwable cause of the error
public InvalidDiameterRequestVariationException(java.lang.Throwable cause)
Page 211
com.redback.npm.common.diameter.InvalidDiameterRequestVariationTypeException
Class InvalidDiameterRequestVariationTypeException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.diameter.InvalidDiameterRequestVariationTypeException
public class InvalidDiameterRequestVariationTypeException extends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the diameter request variation type.
Constructors
InvalidDiameterRequestVariationTypeException
public InvalidDiameterRequestVariationTypeException()
public InvalidDiameterRequestVariationTypeException(java.lang.String message)
Parameters: message - an error message that indicates this diameter request variation type is unrecognizable
public InvalidDiameterRequestVariationTypeException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message that indicates this diameter request variation type is unrecognizable cause - the throwable cause of the error
public InvalidDiameterRequestVariationTypeException(java.lang.Throwable cause)
Page 212
Package
com.redback.npm.common.ldap
Page 213
com.redback.npm.common.ldap.InvalidLdapProxyServerException
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 InvalidLdapProxyServerException extends InvalidProxyServerException

This exception represents an error due to NPM being unable to recognize the ldap proxy server.
Constructors
InvalidLdapProxyServerException
public InvalidLdapProxyServerException()
public InvalidLdapProxyServerException(java.lang.String message)
public InvalidLdapProxyServerException(java.lang.String message, java.lang.Throwable cause)
public InvalidLdapProxyServerException(java.lang.Throwable cause)
Page 214
Package
com.redback.npm.common.license
Page 215
com.redback.npm.common.license.InvalidLicenseException
com.redback.npm.common.license
Class InvalidLicenseException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.license.InvalidLicenseException
public class InvalidLicenseException extends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to recognize this license key.
Constructors
InvalidLicenseException
public InvalidLicenseException(java.lang.String message)
Page 216
Package
com.redback.npm.common.racs
Page 217
com.redback.npm.common.racs.ResourceRequestDeniedException
com.redback.npm.common.racs
Class ResourceRequestDeniedException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.racs.ResourceRequestDeniedException
public class ResourceRequestDeniedException extends java.lang.Exception

This exception represents an error due to the NetOp PM system being unable to grant the requested resources.
Fields
PORT_CONGESTION_POINT
public static final java.lang.String PORT_CONGESTION_POINT
ACCESS_NODE_CONGESTION_POINT
public static final java.lang.String ACCESS_NODE_CONGESTION_POINT
RG_CONGESTION_POINT
public static final java.lang.String RG_CONGESTION_POINT
UNKNOWN_CONGESTION_POINT
public static final java.lang.String UNKNOWN_CONGESTION_POINT
Constructors
ResourceRequestDeniedException
public ResourceRequestDeniedException()
public ResourceRequestDeniedException(java.lang.String message)
Page 218
public ResourceRequestDeniedException(java.lang.Throwable cause)
public ResourceRequestDeniedException(java.lang.String message, java.lang.Throwable cause)
public ResourceRequestDeniedException(java.lang.String cpLevelName, java.lang.String cpId)
Parameters: cpLevelName - the congestion point level name--could be Port, Access, RG, or Unknown cpId - the congestion point identifier
public 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 Unknown cpId - the congestion point identifier message - a detailed error message
public 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 Unknown cpId - the congestion point identifier cause - the throwable cause of the error
Page 219
public 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 Unknown cpId - the congestion point identifier message - a detailed error message cause - the throwable cause of the error
Methods
getCongestionPointLevelName
public java.lang.String getCongestionPointLevelName() Returns the congestion point level name. Returns: the congestion point level name--could be Port, Access, RG, or Unknown
getCongestionPointId
public java.lang.String getCongestionPointId() Returns the congestion point identifier. Returns: the congestion point identifier
getSubscriberCongestion
public 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.InvalidRadiusProxyServerException
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 InvalidRadiusProxyServerException extends InvalidProxyServerException

This exception represents an error due to NPM being unable to recognize the radius proxy server.
Constructors
InvalidRadiusProxyServerException
public InvalidRadiusProxyServerException()
public InvalidRadiusProxyServerException(java.lang.String message)
public InvalidRadiusProxyServerException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - a detailed message cause - the throwable cause of the error
public InvalidRadiusProxyServerException(java.lang.Throwable cause)
Page 222
Package
com.redback.npm.common.service
Page 223
com.redback.npm.common.service.DuplicateServiceAttributeVariationException
Class DuplicateServiceAttributeVariationException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.service.DuplicateServiceAttributeVariationException
public class DuplicateServiceAttributeVariationException extends java.lang.Exception

This exception represents an error when a service attribute variation being added already exists in the NetOp PM system.
Constructors
DuplicateServiceAttributeVariationException
public DuplicateServiceAttributeVariationException()
public DuplicateServiceAttributeVariationException(java.lang.String message)
Parameters: message - an error message indicating this service attribute variation already exists
public DuplicateServiceAttributeVariationException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message indicating this service attribute variation already exists cause - the throwable cause of the error
public DuplicateServiceAttributeVariationException(java.lang.Throwable cause)
Page 224
com.redback.npm.common.service.InvalidServiceAttributeVariationException
Class InvalidServiceAttributeVariationException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.service.InvalidServiceAttributeVariationException
public class InvalidServiceAttributeVariationException extends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the service attribute variation.
Constructors
InvalidServiceAttributeVariationException
public InvalidServiceAttributeVariationException()
public InvalidServiceAttributeVariationException(java.lang.String message)
Parameters: message - an error message that indicates this service attribute variation is unrecognizable
public InvalidServiceAttributeVariationException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message that indicates this service attribute variation is unrecognizable cause - the throwable cause of the error
public InvalidServiceAttributeVariationException(java.lang.Throwable cause)
Page 225
com.redback.npm.common.service.InvalidServiceAttributeVariationTypeException
Class InvalidServiceAttributeVariationTypeException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.service.InvalidServiceAttributeVariationTypeException
public class InvalidServiceAttributeVariationTypeException extends java.lang.Exception

This exception represents an error when the NetOp PM system is unable to recognize the service attribute variation type.
Constructors
InvalidServiceAttributeVariationTypeException
public InvalidServiceAttributeVariationTypeException()
public InvalidServiceAttributeVariationTypeException(java.lang.String message)
Parameters: message - an error message that indicates this service attribute variation type is unrecognizable
public InvalidServiceAttributeVariationTypeException(java.lang.String message, java.lang.Throwable cause)
Parameters: message - an error message that indicates this service attribute variation type is unrecognizable cause - the throwable cause of the error
public InvalidServiceAttributeVariationTypeException(java.lang.Throwable cause)
Page 226
Index
Class ServiceAttributeVariationInUseException
java.lang.Object | +-java.lang.Throwable | +-java.lang.Exception | +-com.redback.npm.common.service.ServiceAttributeVariationInUseException
public class ServiceAttributeVariationInUseException extends java.lang.Exception

This exception represents an error due to an attempt that was made to remove or update a ServiceAttributeVariationwhich is still being used in the NetOp PM system.
Constructors
ServiceAttributeVariationInUseException
public ServiceAttributeVariationInUseException()
public ServiceAttributeVariationInUseException(java.lang.String message)
Parameters: message - an error message that indicates you tried to remove this service attribute variation when it was already in use
public 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 already in use cause - the throwable cause of the error
public ServiceAttributeVariationInUseException(java.lang.Throwable cause)
Page 227

NetOP User Guide

Загружено:

Сведения о документе

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

NetOP User Guide

Загружено:

Авторское право:

Доступные форматы

NetOp Policy Manager API (Javadoc) Guide

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

Rights and Restrictions

NetOp PM API Javadoc Introduction

Method Names and Parameter Types

NetOp PM API Method Names and Parameter Types

Method Names and Parameter Types

NetOp PM API Method Names and Parameter Types (continued)

NetOp Policy Manager API Guide (Javadoc Version)

Method Names and Parameter Types

NetOp PM API Method Names and Parameter Types (continued)

NetOp PM API Javadoc Introduction

Method Names and Parameter Types

NetOp PM API Method Names and Parameter Types (continued)

NetOp Policy Manager API Guide (Javadoc Version)

Method Names and Parameter Types

NetOp PM API Method Names and Parameter Types (continued)

NetOp PM API Javadoc Introduction

Method Names and Parameter Types

NetOp PM API Method Names and Parameter Types (continued)

NetOp Policy Manager API Guide (Javadoc Version)

public class LdapProxyServer extends ProxyServer

nameAttr - the username attribute

public class NAS extends java.lang.Object

the SNMP community for this NAS

Parameters: secret - the secret used to generate CoA authenticators

public class ProxyInfo extends java.lang.Object

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

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

Parameters: serv - the invalid login redirect service identifier

public abstract class ProxyServer extends java.lang.Object implements java.lang.Comparable

public class RadiusProxyServer extends ProxyServer

acctPort - the accounting port number of the radius proxy server

SQLException - if a database access error occurs Since: 1.1.3

RemoteException - if an unexpected error occurs Since: 2.0

public class ServiceSubscription extends java.lang.Object

public class SessionIP extends java.lang.Object

public class NASUser extends java.lang.Object

public class SubscriberAccount extends java.lang.Object

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

public class SubscriberAccountNameList extends java.lang.Object

Parameters: prevCursor - a string value for the previous cursor

public class ActiveSubSessionException extends java.lang.Exception

Parameters: message - a detailed error message

public class AuthenticationReply extends java.lang.Object

Parameters: value - indicates whether the user has been authenticated

Returns: true if the user has been authenticated; otherwise false

public class DuplicateNASException extends java.lang.Exception

Parameters: message - a detailed error message

Parameters: cause - the throwable cause of the error

public class DuplicateNASUserException extends java.lang.Exception

Parameters: message - a detailed error message

Parameters: cause - the throwable cause of the error

public class DuplicateProxyInfoException extends java.lang.Exception

Parameters: message - a detailed error message

Parameters: cause - the throwable cause of the error

public class DuplicateServiceException extends java.lang.Exception

Parameters: message - a detailed error message

Parameters: cause - the throwable cause of the error

public class DuplicateServiceSubscriptionException extends java.lang.Exception

Parameters: message - a detailed error message

public class DuplicateSubscriberAccountException extends java.lang.Exception

Parameters: message - a detailed error message