Interface BrokerProcessorEnablerAdminSession

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

This session creates, updates, and deletes BrokerProcessorEnablers . 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 BrokerProcessorEnabler , a BrokerProcessorEnablerForm is requested using getBrokerProcessorEnablerFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned BrokerProcessorEnablerForm 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 BrokerProcessorEnablerForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each BrokerProcessorEnablerForm corresponds to an attempted transaction.

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

The delete operations delete BrokerProcessorEnablers . To unmap a BrokerProcessorEnabler from the current Distributor , the BrokerProcessorEnablerDistributorAssignmentSession should be used. These delete operations attempt to remove the BrokerProcessorEnabler 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.

    • canCreateBrokerProcessorEnablers

      boolean canCreateBrokerProcessorEnablers()
      Tests if this user can create BrokerProcessorEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a BrokerProcessorEnabler 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 BrokerProcessorEnabler creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateBrokerProcessorEnablerWithRecordTypes

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

    • getBrokerProcessorEnablerFormForCreate

      BrokerProcessorEnablerForm getBrokerProcessorEnablerFormForCreate(Type[] brokerProcessorEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the broker processor enabler form for creating new broker processor enablers. A new form should be requested for each create transaction.
      Parameters:
      brokerProcessorEnablerRecordTypes - array of broker processor enabler record types
      Returns:
      the broker processor enabler form
      Throws:
      NullArgumentException - brokerProcessorEnablerRecordTypes 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.

    • createBrokerProcessorEnabler

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

    • canUpdateBrokerProcessorEnablers

      boolean canUpdateBrokerProcessorEnablers()
      Tests if this user can update BrokerProcessorEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a BrokerProcessorEnabler 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 BrokerProcessorEnabler modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorEnablerFormForUpdate

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

    • updateBrokerProcessorEnabler

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

    • canDeleteBrokerProcessorEnablers

      boolean canDeleteBrokerProcessorEnablers()
      Tests if this user can delete BrokerProcessorEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a BrokerProcessorEnabler 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 BrokerProcessorEnabler deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteBrokerProcessorEnabler

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

    • canManageBrokerProcessorEnablerAliases

      boolean canManageBrokerProcessorEnablerAliases()
      Tests if this user can manage Id aliases for BrokerProcessorEnablers 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 BrokerProcessorEnabler aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasBrokerProcessorEnabler

      void aliasBrokerProcessorEnabler(Id brokerProcessorEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to a BrokerProcessorEnabler for the purpose of creating compatibility. The primary Id of the BrokerProcessorEnabler 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 processor enabler, it is reassigned to the given broker processor enabler Id .
      Parameters:
      brokerProcessorEnablerId - the Id of a BrokerProcessorEnabler
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - brokerProcessorEnablerId not found
      NullArgumentException - brokerProcessorEnablerId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.