Interface BrokerEnablerAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface BrokerEnablerAdminSession extends OsidSession

This session creates, updates, and deletes BrokerEnablers . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a BrokerEnabler , a BrokerEnablerForm is requested using getBrokerEnablerFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned BrokerEnablerForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the BrokerEnablerForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each BrokerEnablerForm corresponds to an attempted transaction.

For updates, BrokerEnablerForms are requested to the BrokerEnabler Id that is to be updated using getBrokerEnablerFormForUpdate() . Similarly, the BrokerEnablerForm has metadata about the data that can be updated and it can perform validation before submitting the update. The BrokerEnablerForm can only be used once for a successful update and cannot be reused.

The delete operations delete BrokerEnablers . To unmap a BrokerEnabler from the current Distributor , the BrokerEnablerDistributorAssignmentSession should be used. These delete operations attempt to remove the BrokerEnabler itself thus removing it from all known Distributor catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id .

  • Method Details

    • getDistributorId

      Id getDistributorId()
      Gets the Distributor Id associated with this session.
      Returns:
      the Distributor Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getDistributor

      Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
      Gets the Distributor associated with this session.
      Returns:
      the distributor
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canCreateBrokerEnablers

      boolean canCreateBrokerEnablers()
      Tests if this user can create BrokerEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a BrokerEnabler will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
      Returns:
      false if BrokerEnabler creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateBrokerEnablerWithRecordTypes

      boolean canCreateBrokerEnablerWithRecordTypes(Type[] brokerEnablerRecordTypes)
      Tests if this user can create a single BrokerEnabler using the desired record types. While ProvisioningRulesManager.getBrokerEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific BrokerEnabler . Providing an empty array tests if a BrokerEnabler can be c reated with no records.
      Parameters:
      brokerEnablerRecordTypes - array of broker enabler record types
      Returns:
      true if BrokerEnabler creation using the specified record Types is supported, false otherwise
      Throws:
      NullArgumentException - brokerEnablerRecordTypes is null
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerEnablerFormForCreate

      BrokerEnablerForm getBrokerEnablerFormForCreate(Type[] brokerEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the broker enabler form for creating new broker enablers. A new form should be requested for each create transaction.
      Parameters:
      brokerEnablerRecordTypes - array of broker enabler record types
      Returns:
      the broker enabler form
      Throws:
      NullArgumentException - brokerEnablerRecordTypes is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - unable to get form for requested record types
      Compliance:
      mandatory - This method must be implemented.

    • createBrokerEnabler

      BrokerEnabler createBrokerEnabler(BrokerEnablerForm brokerEnablerForm) throws OperationFailedException, PermissionDeniedException
      Creates a new BrokerEnabler .
      Parameters:
      brokerEnablerForm - the form for this BrokerEnabler
      Returns:
      the new BrokerEnabler
      Throws:
      IllegalStateException - brokerEnablerForm already used in a create transaction
      InvalidArgumentException - one or more of the form elements is invalid
      NullArgumentException - brokerEnablerForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - brokerEnablerForm did not originate from getBrokerEnablerFormForCreate()
      Compliance:
      mandatory - This method must be implemented.

    • canUpdateBrokerEnablers

      boolean canUpdateBrokerEnablers()
      Tests if this user can update BrokerEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a BrokerEnabler will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
      Returns:
      false if BrokerEnabler modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerEnablerFormForUpdate

      BrokerEnablerForm getBrokerEnablerFormForUpdate(Id brokerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the broker enabler form for updating an existing broker enabler. A new broker enabler form should be requested for each update transaction.
      Parameters:
      brokerEnablerId - the Id of the BrokerEnabler
      Returns:
      the broker enabler form
      Throws:
      NotFoundException - brokerEnablerId is not found
      NullArgumentException - brokerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • updateBrokerEnabler

      void updateBrokerEnabler(BrokerEnablerForm brokerEnablerForm) throws OperationFailedException, PermissionDeniedException
      Updates an existing broker enabler.
      Parameters:
      brokerEnablerForm - the form containing the elements to be updated
      Throws:
      IllegalStateException - brokerEnablerForm already used in an update transaction
      InvalidArgumentException - the form contains an invalid value
      NullArgumentException - brokerEnablerForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - brokerEnablerForm did not originate from getBrokerEnablerFormForUpdate()
      Compliance:
      mandatory - This method must be implemented.

    • canDeleteBrokerEnablers

      boolean canDeleteBrokerEnablers()
      Tests if this user can delete BrokerEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a BrokerEnabler will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
      Returns:
      false if BrokerEnabler deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteBrokerEnabler

      void deleteBrokerEnabler(Id brokerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Deletes a BrokerEnabler .
      Parameters:
      brokerEnablerId - the Id of the BrokerEnabler to remove
      Throws:
      NotFoundException - brokerEnablerId not found
      NullArgumentException - brokerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageBrokerEnablerAliases

      boolean canManageBrokerEnablerAliases()
      Tests if this user can manage Id aliases for BrokerEnablers A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED .This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
      Returns:
      false if BrokerEnabler aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasBrokerEnabler

      void aliasBrokerEnabler(Id brokerEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to a BrokerEnabler for the purpose of creating compatibility. The primary Id of the BrokerEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another broker enabler, it is reassigned to the given broker enabler Id .
      Parameters:
      brokerEnablerId - the Id of a BrokerEnabler
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - brokerEnablerId not found
      NullArgumentException - brokerEnablerId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.