Interface BrokerProcessorAdminSession

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

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

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

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

    • canCreateBrokerProcessors

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

    • canCreateBrokerProcessorWithRecordTypes

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

    • getBrokerProcessorFormForCreate

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

    • createBrokerProcessor

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

    • canUpdateBrokerProcessors

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

    • getBrokerProcessorFormForUpdate

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

    • updateBrokerProcessor

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

    • canDeleteBrokerProcessors

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

    • deleteBrokerProcessor

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

    • canManageBrokerProcessorAliases

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

    • aliasBrokerProcessor

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