Interface BrokerProcessor

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidObject, OsidProcessor, OsidRule
public interface BrokerProcessor extends OsidProcessor

A BrokerProcessor manages the operation of a Broker .

  • Method Details

    • isLeasing

      boolean isLeasing()
      Tests if this broker provides leases. A lease is a temporary provision that expires or must be returned.
      Returns:
      true if this is a leasing broker, false if the brokered provisions are permanent
      Compliance:
      mandatory - This method must be implemented.

    • hasFixedLeaseDuration

      boolean hasFixedLeaseDuration()
      Tests if leases from this broker have fixed durations.
      Returns:
      true if leases have fixed durations, false otherwise
      Throws:
      IllegalStateException - isLeasing() is false
      Compliance:
      mandatory - This method must be implemented.

    • getFixedLeaseDuration

      Duration getFixedLeaseDuration()
      Gets the fixed lease duration.
      Returns:
      the fixed lease duration
      Throws:
      IllegalStateException - hasFixedLeaseDuration() is false
      Compliance:
      mandatory - This method must be implemented.

    • mustReturnProvisions

      boolean mustReturnProvisions()
      Tests if provisions from this broker must be returned.
      Returns:
      true if this broker requires provision return, false otherwise
      Throws:
      IllegalStateException - isLeasing() is false
      Compliance:
      mandatory - This method must be implemented.

    • allowsProvisionExchange

      boolean allowsProvisionExchange()
      Tests if this broker allows exchanging of provisions.
      Returns:
      true if provision exchange is permitted, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • allowsCompoundRequests

      boolean allowsCompoundRequests()
      Tests if this broker allows compound requests using RequestTransactions .
      Returns:
      true if compound requests are permitted, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorRecord

      BrokerProcessorRecord getBrokerProcessorRecord(Type brokerProcessorRecordType) throws OperationFailedException
      Gets the broker processor record corresponding to the given BrokerProcessor record Type . This method ie 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 .
      Parameters:
      brokerProcessorRecordType - the type of broker processor record to retrieve
      Returns:
      the broker processor record
      Throws:
      NullArgumentException - brokerProcessorRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(brokerProcessorRecordType) is false
      Compliance:
      mandatory - This method must be implemented.