org.opennms.netmgt.provision.persist

Interface RequisitionProvider

All Known Implementing Classes:

AbstractRequisitionProvider, DnsRequisitionProvider, FileRequisitionProvider, HttpRequisitionProvider, RequisitionProviderImpl, VmwareRequisitionProvider

public interface RequisitionProvider

Used to generate Requisitions from some source.

Author:

jwhite

Method Summary

Modifier and Type	Method and Description
RequisitionRequest	getRequest(Map<String,String> parameters) Generate a request.
Requisition	getRequisition(RequisitionRequest request) Execute the request.
String	getType() A string used to identify the provider type.
String	marshalRequest(RequisitionRequest request) Marshals the request to a String.
RequisitionRequest	unmarshalRequest(String marshaledRequest) Unmarshals the request from a String.

Method Detail

getType

String getType()

A string used to identify the provider type. This string should be unique for every implementation.

Returns:

the type string

getRequest

RequisitionRequest getRequest(Map<String,String> parameters)

Generate a request.

Parameters:

parameters -

Returns:

getRequisition

Requisition getRequisition(RequisitionRequest request)

Execute the request.

Parameters:

request -

Returns:

marshalRequest

String marshalRequest(RequisitionRequest request)

Marshals the request to a String. Used before sending the request to a Minion.

Parameters:

request -

Returns:

unmarshalRequest

RequisitionRequest unmarshalRequest(String marshaledRequest)

Unmarshals the request from a String. Used when received the request on a Minion.

Parameters:

marshaledRequest -

Returns: