Interface DeviceAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
DeviceBatchAdminSession
public interface DeviceAdminSession extends OsidSession

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

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

The delete operations delete Devices . To unmap a Device from the current System , the DeviceSystemAssignmentSession should be used. These delete operations attempt to remove the Device itself thus removing it from all known System catalogs.

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

  • Method Details

    • getSystemId

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

    • getSystem

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

    • canCreateDevices

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

    • canCreateDeviceWithRecordTypes

      boolean canCreateDeviceWithRecordTypes(Type[] deviceRecordTypes)
      Tests if this user can create a single Device using the desired record types. While ControlManager.getDeviceRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Device . Providing an empty array tests if a Device can be created with no records.
      Parameters:
      deviceRecordTypes - array of device record types
      Returns:
      true if Device creation using the specified record Types is supported, false otherwise
      Throws:
      NullArgumentException - deviceRecordTypes is null
      Compliance:
      mandatory - This method must be implemented.

    • getDeviceFormForCreate

      DeviceForm getDeviceFormForCreate(Type[] deviceRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the device form for creating new devices. A new form should be requested for each create transaction.
      Parameters:
      deviceRecordTypes - array of device record types
      Returns:
      the device form
      Throws:
      NullArgumentException - deviceRecordTypes 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.

    • createDevice

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

    • canUpdateDevices

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

    • getDeviceFormForUpdate

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

    • updateDevice

      void updateDevice(DeviceForm deviceForm) throws OperationFailedException, PermissionDeniedException
      Updates an existing device.
      Parameters:
      deviceForm - the form containing the elements to be updated
      Throws:
      IllegalStateException - deviceForm already used in an update transatcion
      InvalidArgumentException - the form contains an invalid value
      NullArgumentException - deviceForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - deviceForm did not originate from getDeviceFormForUpdate()
      Compliance:
      mandatory - This method must be implemented.

    • canDeleteDevices

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

    • deleteDevice

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

    • canManageDeviceAliases

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

    • aliasDevice

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