Interface PoolProcessorAdminSession

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

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

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

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

    • canCreatePoolProcessors

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

    • canCreatePoolProcessorWithRecordTypes

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

    • getPoolProcessorFormForCreate

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

    • createPoolProcessor

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

    • canUpdatePoolProcessors

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

    • getPoolProcessorFormForUpdate

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

    • updatePoolProcessor

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

    • canDeletePoolProcessors

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

    • deletePoolProcessor

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

    • canManagePoolProcessorAliases

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

    • aliasPoolProcessor

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