public interface Broker extends OsidGovernator
A Broker
manages queues and pools.
Modifier and Type | Method and Description |
---|---|
BrokerRecord |
getBrokerRecord(Type brokerRecordType)
Gets the broker record corresponding to the given
Broker
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
BrokerRecord getBrokerRecord(Type brokerRecordType) throws OperationFailedException
Broker
record Type.
This method is used to retrieve an
object implementing the requested record. The brokerRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(brokerRecordType)
is true
.brokerRecordType
- the type of broker record to retrieveNullArgumentException
- brokerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(brokerRecordType)
is false
mandatory
- This method must be implemented.