com.adventnet.nms.provisioning
Interface ProvisioningAPI

All Superinterfaces:

CommonModuleAPI, java.rmi.Remote

All Known Subinterfaces:

ExtensionAPI

All Known Implementing Classes:

GenericExtension, com.adventnet.nms.provisioning.server.ProvisioningAPIImpl

public interface ProvisioningAPI
extends java.rmi.Remote, CommonModuleAPI

The Provisioning API provides remote access to the provisioning module functions.

Applications can access provisioning templates and enables them to populate and execute the configured operations.

The templates are XML documents that have parameterized provisioning
profiles for configuring multiple devices in the network.
Format of Templates is available as Template.dtd under < Web NMS Home >/provisioningtemplates directory.
The operator while doing the provisioning operation will provide the parameters. The templates also contain information for automatically rendering the forms that request these parameters from the operator during provisioning.

When a template is requested by the client, it is actually loaded from
< Web NMS Home >/provisioningtemplates directory for supporting dynamic changes of templates.

Templates can be executed in two different ways:

asynchronous - execution is scheduled and an OperationIdentifier is given to the client. Status and final result of the execution will be provided when requested for that particular OperationIdentifier.

synchronous - it will wait till the execution completed and returns the final result.

In addition, it provides access to extension apis. Extension apis provide domain and vendor specific capabilities for remote access. Extension apis need to be specified in the < Web NMS Home >/conf/ProvisioningExtensions.xml in order to access it through ProvisioningAPI.

Once WEBNMS server starts, clients on a remote host can get a handle of ProvisioningAPI using methods available in the com.adventnet.nms.provisioning.messaging.ProvClientUtils class.

Since:

2.3

See Also:

ExtensionAPI, Template

Method Summary

void	cancelExecution(long prId) This method is to cancel the execution of the template if the status of the ProvisionResult is in any one of the following states.
void	cleanUpResources() This method is used to clean up resources (memory) that were used by the Provisioning Operation.
void	deleteProvisionResult(long prId) This method is used to delete Provision Result for the given Provision Result ID.
void	deleteProvisionResult(long prId, boolean forcefulDelete) This method is used to delete Provision Result for the given Provision Result ID.
void	deleteScheduledInfo(long id) This method is used to delete the ScheduledInfo object i.e., cancelling the execution of scheduled template.
boolean	deRegisterScheduledInfoListener(com.adventnet.nms.provisioning.ScheduledInfoListener sil) This method is used to de-register the ScheduledInfoListener which is registered to get the update regarding the ScheduledInfo.
void	disableScheduledInfo(long id) This method is used to disable the scheduled template from execution.
void	enableScheduledInfo(long id) This method is used to enable the disabled scheduled template for future execution.
java.util.Hashtable	getAllScheduledInfo() This method is used to get all the ScheduledInfo details of the scheduled templates.
ProvisioningAPI	getExtensionAPI(java.lang.String apiName) Get an available Provisioning API extension by name.
java.lang.String	getProvisionResultDetails(long prId) This method is used to get the Details of the given Provision Result id.
java.lang.String	getProvisionResultStatus(long prId) This method is used to get the Status of the given Provision Result id.
java.lang.String	getResult(java.lang.String operationIdentifier) Get the result of an asynchronous operation.
java.lang.String	getStatus(java.lang.String operationIdentifier) Get the status of an asynchronous operation.
java.lang.String	getTemplate(java.lang.String name) Get provisioning template from server by name.
java.lang.String	getTemplate(java.lang.String name, java.lang.String params) Get provisioning template from server by name.
java.lang.String	getTemplate(java.lang.String path, java.lang.String name, java.lang.String params) Get provisioning template with the given name in the specified path from server by name.
java.lang.String[]	getTemplateList() Get list of provisioning templates configured on the server.
java.lang.String[]	getTemplateList(java.lang.String path) Get list of provisioning templates from the specified path, configured on the server.
java.lang.String	getTemplateParameters(java.lang.String name) Get provisioning template input parameters, which may be needed for initial population of the template.
java.lang.String	getTemplateParameters(java.lang.String path, java.lang.String name) Get provisioning template input parameters, which may be needed for initial population of the template given in the specified path.
java.util.Properties	getUserInputs(long prId) This method is used to get the user input properties for the given ProvisionResult Id.
void	modifyScheduledInfo(long id, java.util.Properties prop) This method is used to modify the scheduled properties in the ScheduledInfo object and the same change will reflect in the scheduled template.
void	modifyScheduledInfo(long id, java.lang.String key, java.lang.String value) This method is used to modify single property of the ScheduledInfo object and the same change will reflect in the scheduled template.
java.lang.String	provision(java.lang.String template) The specified template is executed synchronously or asynchronously.
boolean	registerScheduledInfoListener(com.adventnet.nms.provisioning.ScheduledInfoListener sil) This method is used to register the ScheduledInfoListener to get the update regarding the ScheduledInfo.
void	setUserInputs(long prId, java.lang.String templateName, java.util.Properties userInputs) This method is used to set the user input properties for the given ProvisionResult Id and template.
void	updateDetails(long prId, java.lang.String details) This method is used to update the Details of the given Provision Result id.
void	updateStatus(long prId, java.lang.String status) This method is used to update the Status of the given Provision Result id.
void	updateStatusAndDetails(long prId, java.lang.String status, java.lang.String details) This method is used to update the Status and the Details of the given Provision Result id.

Method Detail

getExtensionAPI

ProvisioningAPI getExtensionAPI(java.lang.String apiName)
                                throws java.rmi.RemoteException,
                                       ExtensionNotFoundException

Get an available Provisioning API extension by name. Extension apis specified in the
< Web NMS Home >/conf/ProvisioningExtensions.xml file are loaded into the memory during startup and returned when corresponding name requested. Multiple domain and application specific extensions can be implemented and this method is used for exposing them.

Parameters:

apiName - The name of the API extension

Returns:

The Provisioning API extension

Throws:

java.rmi.RemoteException - if an error occurs

ExtensionNotFoundException - if there is no ExtensionAPI named apiName in < WEb NMS Home >/conf/ProvisioningExtensions.xml file or if error occurs in getting extension API named apiName.

See Also:

ExtensionAPI

getTemplateList

java.lang.String[] getTemplateList()
                                   throws java.rmi.RemoteException

Get list of provisioning templates configured on the server. Names of Templates present in the
< Web NMS Home >/provisioningtemplates directory are returned when this method is invoked. Definition of Template is specified in Template.dtd. This is available in
< Web NMS Home >/provisioningtemplates directory.

Returns:

list of provisioning template names configured on the server. Returns null if < Web NMS Home >/provisioningtemplates directory does not contain Template xmls.

Throws:

java.rmi.RemoteException - if an error occurs

See Also:

Template

getTemplateList

java.lang.String[] getTemplateList(java.lang.String path)
                                   throws java.rmi.RemoteException

Get list of provisioning templates from the specified path, configured on the server. Names of Templates present in the specified path relative to < Web NMS Home >/provisioningtemplates directory are returned when this method is invoked.

Parameters:

path - The path relative to < Web NMS Home >/provisioningtemplates directory.
If path is specified as empty string, then the path will be considered as < Web NMS Home >/provisioningtemplates directory

Returns:

list of provisioning template names configured on the server. Returns null if the path relative to < Web NMS Home >/provisioningtemplates directory does not contain Template xmls.

Throws:

java.rmi.RemoteException - if an error occurs

See Also:

getTemplateList()

getTemplate

java.lang.String getTemplate(java.lang.String name)
                             throws java.rmi.RemoteException,
                                    TemplateNotFoundException,
                                    TemplateInitializationException

Get provisioning template from server by name. The template will be loaded from the < WEb NMS Home >/provisioningtemplates directory. It is essential that the name of the template and file name should be same for proper loading of xml file. The loaded xml string will be parsed and validated against Template.dtd. InvalidTemplateException will be thrown if the xml is not written according to the Template.dtd. After template element is created, initialization processes starts if TemplateParameters are not present in the template. The first Stage element present in the template will be the initialization stage. This Stage element should initialize the requirements of provisioning operation. The elements in the first Stage will be executed one by one in the order specified. If the child element is Initialization, then the database connection will be created as specified in it. If the child element is NEInput, then network data will be collected as specified in it. If the child element is InventoryInput, then data will be collected from database as specified in it. When the child element is other than InventoryInput and NEInput, TemplateFilters will be applied. A template can be associated with any number of TemplateFilters. A particular filter is associated with a template in ProvisioningFilters.xml file. This file is present under the < Web NMS Home >/conf directory. After the TemplateFilters are applied, it will be sent to the client. If the first Stage contains only InventoryInput and NEInput elements, then TemplateFilters will be applied at the end of first Stage. If the template contains one or more TemplateParameters( identified by the "$TemplateParam$" token), then the template will be returned as such in the server without any population and filtering. If initialization processes are required, then ProvisioningAPIImpl#getTemplate(String, String) method can be used. Template.dtd is available under < Web NMS Home >/provisioningtemplates directory.

Parameters:

name - The name of the template

Returns:

The template returned as an XML string

Throws:

java.rmi.RemoteException - if an error occurs

TemplateNotFoundException - If the specified name appended with ".xml" file is not present in the < Web NMS Home >/provisioningtemplates directory.

TemplateInitializationException - if an error occurs during template initialization.

See Also:

Template, TemplateFilter

getTemplate

java.lang.String getTemplate(java.lang.String name,
                             java.lang.String params)
                             throws java.rmi.RemoteException,
                                    TemplateNotFoundException,
                                    TemplateInitializationException

Get provisioning template from server by name. The template will be loaded from the < Web NMS Home >/provisioningtemplates directory. It is essential that the name of the template and file name should be same for proper loading of xml file. The loaded xml string will be parsed and validated against Template.dtd. InvalidTemplateException will be thrown if the xml is not written according to the Template.dtd. After template element is created, initialization processes starts. The first step is applying the specified TemplateParameters on the Template. Then the first Stage element will be taken from the template. The first Stage element will be the initialization stage. This Stage element should initialize the requirements of provisioning operation. The elements in the first Stage will be executed one by one in the order specified. If the child element is Initialization, then the database connection will be created as specified in it. If the child element is NEInput, then network data will be collected as specified in it. If the child element is InventoryInput, then data will be collected from database as specified in it. When the child element is other than InventoryInput and NEInput, TemplateFilters will be applied. A template can be associated with any number of TemplateFilters. A particular filter is associated with a template in ProvisioningFilters.xml file. This file is present under the < Web NMS Home >/conf directory. After the TemplateFilters are applied, it will be sent to the client. If the first Stage contains only InventoryInput and NEInput elements, then TemplateFilters will be applied at the end of first Stage. Template.dtd is available under < Web NMS Home >/provisioningtemplates directory.

Parameters:

name - The name of the template

params - Template parameters for initializing the template.

Returns:

The template returned as an XML string

Throws:

java.rmi.RemoteException - if an error occurs

TemplateNotFoundException - If the specified name appended with ".xml" file is not present in the < Web NMS Home >/provisioningtemplates directory.

TemplateInitializationException - if an error occurs during template initialization.

See Also:

Template, TemplateFilter

getTemplate

java.lang.String getTemplate(java.lang.String path,
                             java.lang.String name,
                             java.lang.String params)
                             throws java.rmi.RemoteException,
                                    TemplateNotFoundException,
                                    TemplateInitializationException

Get provisioning template with the given name in the specified path from server by name. The template will be loaded from the specified path relative to
< Web NMS Home >/provisioningtemplates directory.

Parameters:

path - The path relative to < Web NMS Home >/provisioningtemplates directory If path is specified as empty string, then the path will be considered as < Web NMS Home >/provisioningtemplates directory

name - The name of the template

params - Template parameters for initializing the template. If there is no template parameters to be initialized, then it should be given as null. If the template has template input parameters and the params argument is null, then the template will be returned as an XML string without any template input parameter replacement.

Returns:

The template is returned as an XML string

Throws:

java.rmi.RemoteException - if an error occurs

TemplateNotFoundException - Occurs if the specified name appended with ".xml" file is not present in the specified path relative to < Web NMS Home >/provisioningtemplates directory.

TemplateInitializationException - if an error occurs during template initialization.

See Also:

getTemplate(String name), getTemplate(String name, String params)

getTemplateParameters

java.lang.String getTemplateParameters(java.lang.String name)
                                       throws java.rmi.RemoteException,
                                              TemplateNotFoundException

Get provisioning template input parameters, which may be needed for initial population of the template. In most cases, this method is not used because this knowledge is built into the provisioning application, e.g. the selected network element is a template parameter when configuring the NE from a map. Returned string will be in the following form:
< TemplateParams > < Property name="parameter-name" value="" /> < TemplateParams />

Parameters:

name - The name of the template

Throws:

java.rmi.RemoteException - if an error occurs

TemplateNotFoundException - Occurs if the specified name appended with ".xml" file is not present in the < Web NMS Home >/provisioningtemplates directory.

See Also:

TemplateParams

getTemplateParameters

java.lang.String getTemplateParameters(java.lang.String path,
                                       java.lang.String name)
                                       throws java.rmi.RemoteException,
                                              TemplateNotFoundException

Get provisioning template input parameters, which may be needed for initial population of the template given in the specified path. Returned string will be in the following form:
< TemplateParams > < Property name="parameter-name" value="" /> < TemplateParams />

Parameters:

path - The path relative to < Web NMS Home >/provisioningtemplates directory If path is specified as empty string, then the path will be considered as < Web NMS Home >/provisioningtemplates directory

name - The name of the template

Throws:

java.rmi.RemoteException - if an error occurs

TemplateNotFoundException - Occurs if the specified name appended with ".xml" file is not present in the specified path relative to < Web NMS Home >/provisioningtemplates directory.

See Also:

getTemplateParameters(String name)

getStatus

java.lang.String getStatus(java.lang.String operationIdentifier)
                           throws java.rmi.RemoteException,
                                  NoSuchOperationException

Get the status of an asynchronous operation. OperationIdentifier returned by the asynchronous execution
is used to know the status of the operation. Returned status may be one among the following: "NOTSTARTED", "INPROGRESS", "FINISHED" or "FINISHED_RESCHEDULED". If the status is "NOTSTARTED", then it means that provisioning operation is not yet started. If the status is "INPROGRESS", then it means that provisioning operation is started and yet to be completed. If the status is "FINISHED", then it means that provisioning operation is completed. If the status is "FINISHED_RESCHEDULED", then it means that provisioning operation is completed and rescheduled.

Parameters:

operationIdentifier - The OperationIdentifier of the operation

Returns:

The status of the provisioning operation

Throws:

java.rmi.RemoteException - if an error occurs

NoSuchOperationException - if there is no operation exists with the specified OperationIdentifier.

See Also:

provision(String template)

getResult

java.lang.String getResult(java.lang.String operationIdentifier)
                           throws java.rmi.RemoteException,
                                  IncompleteOperationException

Get the result of an asynchronous operation. OperationIdentifier returned by the asynchronous execution
is used to know the result of the operation. An IncompleteOperationException is thrown if this method is invoked before the execution of the operation completed. The completion of an operation is indicated by the status of the operation as "FINISHED" or "FINISHED_RESCHEDULED". The returned XML (ie., TemplateResult in string format)has the complete results of what was provisioned.
Format of TemplateResult is available as TemplateResult.dtd under < Web NMS Home >/provisioningtemplates directory.

Parameters:

operationIdentifier - The OperationIdentifier of the operation

Returns:

The results of the provisioning operation as XML string

Throws:

java.rmi.RemoteException - if an error occurs

IncompleteOperationException - if the operation identified by the operationidentifier had not been completed.

See Also:

provision(String template), TemplateResult

provision

java.lang.String provision(java.lang.String template)
                           throws java.rmi.RemoteException,
                                  InvalidTemplateException,
                                  OperationFailedException

The specified template is executed synchronously or asynchronously.
Client will supply the populated template for provisioning operation.
If the supplied template contains "when" attribute and if its value is not empty string,
then template will be provisioned asynchronously. The identifier xml string , named as
OperationIdentifier, will be return to the client. Client should use this OperationIdentifier
for querying the status and result of the provisioning operation. Definition of
OperationIdentifier xml is specified in OperationIdentifier.dtd. It is available in
< Web NMS Home >/provisioningtemplates directory. If the "when" has invalid time format, then InvalidTemplateException will be thrown. Template.dtd can be referred for valid time format. In the absence of "when" attribute, the template will be executed synchronously. The server will know the element from where to start execution only when the specified templateString is got from the getTemplate(String)method or getTemplate(String, String)method and populated with the user inputs. When the client invokes this method, the server will start execution from the element where it stops while getTemplate() method for the same template is invoked. Elements in a Stage will be executed one by one until "ConfigTask" or "InventoryUpdate" element is encountered. Once it is encountered, PreProvisioningFilters will be applied and then keeps on executing the "ConfigTask" or "InventoryUpdate" element. The elements in a Stage after "ConfigTask" or "InventoryUpdate" element should only be "ConfigTask" or "InventoryUpdate" or "GoTo" element. Otherwise the server will throw InvalidTemplateException. If a Stage contains a "InventoryUpdate" before "ConfigTask" elements, then the criteria should be "always". Otherwise InvalidTemplateException will be thrown. Once execution of all the elements in that stage is completed, PostProvisioning filters will be applied. Then the next stage will be executed. The special case may be a stage without ConfigTask and InventoryUpdate. In that situation, PreProvisioningFilters will be applied after finishing execution of all the elements in that stage. Then PostProvisioningFilters will be invoked. Whenever "Form" element is encountered inside a Stage, the template will be sent to the client for collecting user inputs. Client should call this method after collecting the user inputs and populating them on template. This method will start execution from the next element to the "Form" element. At the end of execution of all stages, TemplateResult in string format will be returned to the client. Definition of TemplateResult is specified in TemplateResult.dtd. It is available under < Web NMS Home >/provisioningtemplates directory.

Parameters:

template - Template in string format

Returns:

String format of Template or TemplateResult or OperationIdentifier

Throws:

java.rmi.RemoteException - if an error occurs

OperationFailedException - If Provisioning operation is failed due to some errors occured.

InvalidTemplateException - If the template fails to be fit in the above explained rules.

cleanUpResources

void cleanUpResources()
                      throws java.rmi.RemoteException

This method is used to clean up resources (memory) that were used by the Provisioning Operation.

Throws:

java.rmi.RemoteException - throws if any Provisioning Operation currently use the resources.

registerScheduledInfoListener

boolean registerScheduledInfoListener(com.adventnet.nms.provisioning.ScheduledInfoListener sil)
                                      throws java.rmi.RemoteException

This method is used to register the ScheduledInfoListener to get the update regarding the ScheduledInfo.

Parameters:

sil - The ScheduledInfoListener object which is going to be registered

Returns:

a boolean value to indicate whether the ScheduledInfoListener object is registered.

Throws:

java.rmi.RemoteException - if an error occurs

deRegisterScheduledInfoListener

boolean deRegisterScheduledInfoListener(com.adventnet.nms.provisioning.ScheduledInfoListener sil)
                                        throws java.rmi.RemoteException

This method is used to de-register the ScheduledInfoListener which is registered to get the update regarding the ScheduledInfo.

Parameters:

sil - The ScheduledInfoListener object which is going to be de-registered

Returns:

a boolean value to indicate whether the ScheduledInfoListener object is de-registered.

Throws:

java.rmi.RemoteException - if an error occurs

getAllScheduledInfo

java.util.Hashtable getAllScheduledInfo()
                                        throws java.rmi.RemoteException

This method is used to get all the ScheduledInfo details of the scheduled templates.

Returns:

a Hashtable with ScheduledInfo Id as the key and the corresponding ScheduledInfo object as the value.

Throws:

java.rmi.RemoteException - if an error occurs

modifyScheduledInfo

void modifyScheduledInfo(long id,
                         java.util.Properties prop)
                         throws java.rmi.RemoteException,
                                com.adventnet.nms.provisioning.InvalidScheduledInfoException

This method is used to modify the scheduled properties in the ScheduledInfo object and the same change will reflect in the scheduled template.

Parameters:

id - ScheduledInfo Id

prop - Modified scheduled properties. The properties which can be modified are scheduledTime, period, count, until Values of scheduledTime & until should be in milliseconds Values of period should follow Template.dtd

Throws:

java.rmi.RemoteException - if an error occurs

InvalidScheduledInfoException - if the given id or properties are invalid

See Also:

ScheduledInfo

modifyScheduledInfo

void modifyScheduledInfo(long id,
                         java.lang.String key,
                         java.lang.String value)
                         throws java.rmi.RemoteException,
                                com.adventnet.nms.provisioning.InvalidScheduledInfoException

This method is used to modify single property of the ScheduledInfo object and the same change will reflect in the scheduled template.

Parameters:

id - ScheduledInfo Id

key - Modified scheduled property name. Property name should be any one of the following : scheduledTime, period, count, until

value - Modified scheduled property value Values of scheduledTime & until should be in milliseconds Values of period should follow Template.dtd

Throws:

java.rmi.RemoteException - if an error occurs

InvalidScheduledInfoException - if the given id or the key, value string are invalid

See Also:

ScheduledInfo

enableScheduledInfo

void enableScheduledInfo(long id)
                         throws java.rmi.RemoteException,
                                com.adventnet.nms.provisioning.InvalidScheduledInfoException

This method is used to enable the disabled scheduled template for future execution.

Parameters:

id - ScheduledInfo Id

Throws:

java.rmi.RemoteException - if an error occurs

InvalidScheduledInfoException - if the given id is invalid

disableScheduledInfo

void disableScheduledInfo(long id)
                          throws java.rmi.RemoteException,
                                 com.adventnet.nms.provisioning.InvalidScheduledInfoException

This method is used to disable the scheduled template from execution.

Parameters:

id - ScheduledInfo Id

Throws:

java.rmi.RemoteException - if an error occurs

InvalidScheduledInfoException - if the given id is invalid

deleteScheduledInfo

void deleteScheduledInfo(long id)
                         throws java.rmi.RemoteException,
                                com.adventnet.nms.provisioning.InvalidScheduledInfoException

This method is used to delete the ScheduledInfo object i.e., cancelling the execution of scheduled template.

Parameters:

id - ScheduledInfo Id

Throws:

java.rmi.RemoteException - if an error occurs

InvalidScheduledInfoException - if ther given id is invalid

getUserInputs

java.util.Properties getUserInputs(long prId)
                                   throws java.rmi.RemoteException,
                                          com.adventnet.nms.provisioning.InvalidProvisionResultException,
                                          NmsStorageException

This method is used to get the user input properties for the given ProvisionResult Id.

Parameters:

prId - ProvisionResult Id

Returns:

UserInput properties for the given ProvisionResult Id. The returned properties will have template name as key and the UserInput properties as value.

Throws:

java.rmi.RemoteException - if an error occurs

com.adventnet.nms.provisioning.InvalidProvisionResultException - if the ProvisionResult Id is invalid

NmsStorageException - If any Database related exception occurs.

setUserInputs

void setUserInputs(long prId,
                   java.lang.String templateName,
                   java.util.Properties userInputs)
                   throws java.rmi.RemoteException,
                          com.adventnet.nms.provisioning.InvalidProvisionResultException,
                          NmsStorageException

This method is used to set the user input properties for the given ProvisionResult Id and template.

Parameters:

prId - ProvisionResult Id

templateName - Template Name

userInputProp - UserInput properties

Throws:

java.rmi.RemoteException - if an error occurs

com.adventnet.nms.provisioning.InvalidProvisionResultException - if the ProvisionResult Id is invalid

NmsStorageException - If any Database related exception occurs.

getProvisionResultStatus

java.lang.String getProvisionResultStatus(long prId)
                                          throws java.rmi.RemoteException,
                                                 com.adventnet.nms.provisioning.InvalidProvisionResultException,
                                                 NmsStorageException

This method is used to get the Status of the given Provision Result id.

Parameters:

prId - ProvisionResult Id

Returns:

status of the given Returned status may be one among the following: "SCHEDULED","WAITING", "INPROGRESS","SUCCEEDED","FAILED","CANCELLED", "ABORTED".
If the status is "SCHEDULED", then it means that provisioning operation is scheduled for execution.
If the status is "WAITING" ,then it means that the provisioning operation is in WAITING state.i.e., it is waiting for the device to be free. If the status is "INPROGRESS", then it means that provisioning operation is started and yet to be completed. If the status is "SUCCEEDED", then it means that provisioning operation is completed. If the status is "FAILED", then it means that the overall status of the provisioning operation is failed. If the status is "CANCELLED", then it means that the provisioning operation is cancelled from execution. If the status is "ABORTED", then it means that the provisioning operation is aborted due to some error or intentionally by the client.

Throws:

java.rmi.RemoteException - if an error occurs

com.adventnet.nms.provisioning.InvalidProvisionResultException - if the given prId is wrong

NmsStorageException - If any Database related exception occurs.

getProvisionResultDetails

java.lang.String getProvisionResultDetails(long prId)
                                           throws java.rmi.RemoteException,
                                                  com.adventnet.nms.provisioning.InvalidProvisionResultException,
                                                  NmsStorageException

This method is used to get the Details of the given Provision Result id.

Parameters:

prId - ProvisionResult Id

Returns:

details of the given prId

Throws:

java.rmi.RemoteException - if an error occurs

com.adventnet.nms.provisioning.InvalidProvisionResultException - if the given prId is wrong

NmsStorageException - If any Database related exception occurs.

updateStatus

void updateStatus(long prId,
                  java.lang.String status)
                  throws java.rmi.RemoteException,
                         com.adventnet.nms.provisioning.InvalidProvisionResultException,
                         NmsStorageException

This method is used to update the Status of the given Provision Result id.

Parameters:

prId - ProvisionResult Id

Throws:

java.rmi.RemoteException - if an error occurs

com.adventnet.nms.provisioning.InvalidProvisionResultException - if the given prId is wrong

NmsStorageException - If any Database related exception occurs.

updateDetails

void updateDetails(long prId,
                   java.lang.String details)
                   throws java.rmi.RemoteException,
                          com.adventnet.nms.provisioning.InvalidProvisionResultException,
                          NmsStorageException

This method is used to update the Details of the given Provision Result id.

Parameters:

prId - ProvisionResult Id

Throws:

java.rmi.RemoteException - if an error occurs

com.adventnet.nms.provisioning.InvalidProvisionResultException - if the given prId is wrong

NmsStorageException - If any Database related exception occurs.

updateStatusAndDetails

void updateStatusAndDetails(long prId,
                            java.lang.String status,
                            java.lang.String details)
                            throws java.rmi.RemoteException,
                                   com.adventnet.nms.provisioning.InvalidProvisionResultException,
                                   NmsStorageException

This method is used to update the Status and the Details of the given Provision Result id.

Parameters:

prId - ProvisionResult Id

Throws:

java.rmi.RemoteException - if an error occurs

com.adventnet.nms.provisioning.InvalidProvisionResultException - if the given prId is wrong

NmsStorageException - If any Database related exception occurs.

deleteProvisionResult

void deleteProvisionResult(long prId)
                           throws java.rmi.RemoteException,
                                  com.adventnet.nms.provisioning.InvalidProvisionResultException,
                                  NmsStorageException,
                                  ProvisioningException

This method is used to delete Provision Result for the given Provision Result ID. Only the ProvisionResult,the execution of which is completed can be deleted.

Parameters:

prId - ProvisionResult Id

Throws:

java.rmi.RemoteException - if an error occurs

NmsStorageException - If any Database related exception occurs.

com.adventnet.nms.provisioning.InvalidProvisionResultException - if the given prId is wrong

ProvisioningException

deleteProvisionResult

void deleteProvisionResult(long prId,
                           boolean forcefulDelete)
                           throws java.rmi.RemoteException,
                                  com.adventnet.nms.provisioning.InvalidProvisionResultException,
                                  NmsStorageException,
                                  ProvisioningException

This method is used to delete Provision Result for the given Provision Result ID.

Parameters:

prId - ProvisionResult Id

forcefulDelete - boolean value to indicate the deletion of ProvisionResult irrespective of it's current status

Throws:

java.rmi.RemoteException - if an error occurs

NmsStorageException - If any Database related exception occurs.

com.adventnet.nms.provisioning.InvalidProvisionResultException - if the given prId is wrong

ProvisioningException

cancelExecution

void cancelExecution(long prId)
                     throws java.rmi.RemoteException,
                            ProvisioningException,
                            com.adventnet.nms.provisioning.InvalidProvisionResultException,
                            NmsStorageException

This method is to cancel the execution of the template if the status of the ProvisionResult is in any one of the following states.

1. SCHEDULED
2. WAITING

Parameters:

prId - ProvisionResult Id of the template for which the execution has to be cancelled.

Throws:

java.rmi.RemoteException - if an error occurs

ProvisioningException - thrown if the template is either in execution or completed.

com.adventnet.nms.provisioning.InvalidProvisionResultException - if the given prId is wrong

NmsStorageException - If any Database related exception occurs.