public interface BrokerProcessor extends OsidProcessor
A BrokerProcessor
describes the rules for managing
broker operations.
Modifier and Type | Method and Description |
---|---|
boolean |
allowsCompoundRequests()
Tests if this broker allows compound requests using
RequestTransactions. |
boolean |
allowsProvisionExchange()
Tests if this broker allows exchanging of provisions.
|
BrokerProcessorRecord |
getBrokerProcessorRecord(Type brokerProcessorRecordType)
Gets the broker processor record corresponding to the given
BrokerProcessor record Type. |
Duration |
getFixedLeaseDuration()
Gets the fixed lease duration.
|
boolean |
hasFixedLeaseDuration()
Tests if leases from this broker have fixed durations.
|
boolean |
isLeasing()
Tests if this broker provides leases.
|
boolean |
mustReturnProvisions()
Tests if provisions from this broker must be returned.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
boolean isLeasing()
mandatory
- This method must be implemented. boolean hasFixedLeaseDuration()
true
if leases have fixed durations,
false
otherwiseIllegalStateException
- isLeasing()
is
false
mandatory
- This method must be implemented. Duration getFixedLeaseDuration()
IllegalStateException
- hasFixedLeaseDuration()
is false
mandatory
- This method must be implemented. boolean mustReturnProvisions()
true
if this broker requires provision return,
false
otherwiseIllegalStateException
- isLeasing()
is
false
mandatory
- This method must be implemented. boolean allowsProvisionExchange()
true
if provision exchange is permitted,
false
otherwisemandatory
- This method must be implemented. boolean allowsCompoundRequests()
RequestTransactions.
true
if compound requests are permitted,
false
otherwisemandatory
- This method must be implemented. BrokerProcessorRecord getBrokerProcessorRecord(Type brokerProcessorRecordType) throws OperationFailedException
BrokerProcessor
record Type.
This method is
used to retrieve an object implementing the requested record. The
brokerProcessorRecordType
may be the Type
returned in getRecordTypes()
or any of its
parents in a Type
hierarchy where
hasRecordType(brokerProcessorRecordType)
is true
.brokerProcessorRecordType
- the type of broker processor record
to retrieveNullArgumentException
-
brokerProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(brokerProcessorRecordType)
is
false
mandatory
- This method must be implemented.