Interface FilingAllocationManager

All Superinterfaces:
AutoCloseable, Closeable, FilingAllocationProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface FilingAllocationManager extends OsidManager, FilingAllocationProfile

The filing allocation manager provides access sessions to retrieve and manage allocations. The sessions included in this manager are:

  • AllocationSession : a session for accessing usage information and quotas for the current user
  • AllocationLookupSession : a session for accessing usage information and quotas
  • AllocationAdminSession a session for assigning quotas
  • AllocationNotificationSession : a session for subscribing to usage warnings and quota changes

  • Method Details

    • getAllocationSession

      AllocationSession getAllocationSession() throws OperationFailedException
      Gets the session for accessing usage and quotas.
      Returns:
      an AllocationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAllocation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAllocation()} is {@code true} .

    • getAllocationSessionForDirectory

      AllocationSession getAllocationSessionForDirectory(String directoryPath) throws NotFoundException, OperationFailedException
      Gets the session for accessing usage and quotas for a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
      Parameters:
      directoryPath - the pathname to the directory
      Returns:
      an AllocationSession
      Throws:
      InvalidArgumentException - directoryPath is not a directory or an alias to a directory
      NotFoundException - directoryPath is not found
      NullArgumentException - directoryPath is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAllocation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAllocation()} and {@code supportsVisibleFederation()} are {@code true} .

    • getAllocationLookupSession

      AllocationLookupSession getAllocationLookupSession() throws OperationFailedException
      Gets the session for accessing usage and quotas.
      Returns:
      an AllocationLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAllocationLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAllocationLookup()} is {@code true} .

    • getAllocationLookupSessionForDirectory

      AllocationLookupSession getAllocationLookupSessionForDirectory(String directoryPath) throws NotFoundException, OperationFailedException
      Gets the session for accessing usage and quotas for a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
      Parameters:
      directoryPath - the pathname to the directory
      Returns:
      an AllocationLookupSession
      Throws:
      InvalidArgumentException - directoryPath is not a directory or an alias to a directory
      NotFoundException - directoryPath is not found
      NullArgumentException - directoryPath is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAllocationLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAllocationLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getAllocationAdminSession

      AllocationAdminSession getAllocationAdminSession() throws OperationFailedException
      Gets the session for assigning quotas.
      Returns:
      an AllocationAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAllocationAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAllocationAdmin()} is {@code true} .

    • getAllocationAdminSessionForDirectory

      AllocationAdminSession getAllocationAdminSessionForDirectory(String directoryPath) throws NotFoundException, OperationFailedException
      Gets the session for assigning quotas for the given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
      Parameters:
      directoryPath - the pathname to the directory
      Returns:
      an AllocationAdminSession
      Throws:
      InvalidArgumentException - directoryPath is not a directory or an alias to a directory
      NotFoundException - directoryPath is not found
      NullArgumentException - directoryPath is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAllocationAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAllocationAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getAllocationNotificationSession

      AllocationNotificationSession getAllocationNotificationSession(AllocationReceiver allocationReceiver) throws OperationFailedException
      Gets the session for receiving messages about changes to directories.
      Parameters:
      allocationReceiver - the notification callback
      Returns:
      an AllocationNotificationSession
      Throws:
      NullArgumentException - allocationReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAllocationNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDirectoryNotification()} is {@code true} .

    • getAllocationNotificationSessionForDirectory

      AllocationNotificationSession getAllocationNotificationSessionForDirectory(AllocationReceiver allocationReceiver, String directoryPath) throws NotFoundException, OperationFailedException
      Gets the session for receiving messages about usage warnings and quota changes for the given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
      Parameters:
      allocationReceiver - the notification callback
      directoryPath - the pathname to the directory
      Returns:
      an AllocationNotificationSession
      Throws:
      InvalidArgumentException - directoryPath is not a directory or an alias to a directory
      NotFoundException - directoryPath is not found
      NullArgumentException - allocationReceiver or directoryPath is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAllocationNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAllocationNotification()} and {@code supportsVisibleFederation()} are {@code true} .