Interface QueueProcessorAdminSession

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

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

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

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

    • canCreateQueueProcessors

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

    • canCreateQueueProcessorWithRecordTypes

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

    • getQueueProcessorFormForCreate

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

    • createQueueProcessor

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

    • canUpdateQueueProcessors

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

    • getQueueProcessorFormForUpdate

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

    • updateQueueProcessor

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

    • canDeleteQueueProcessors

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

    • deleteQueueProcessor

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

    • canManageQueueProcessorAliases

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

    • aliasQueueProcessor

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