Interface EdgeEnablerAdminSession

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

This session creates and removes edge enablers. The data for create and update is provided via the EdgeEnablerForm .

  • Method Details

    • getGraphId

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

    • getGraph

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

    • canCreateEdgeEnabler

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

    • canCreateEdgeEnablerWithRecordTypes

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

    • getEdgeEnablerFormForCreate

      EdgeEnablerForm getEdgeEnablerFormForCreate(Type[] edgeEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the edge enabler form for creating new edge enablers. A new form should be requested for each create transaction.
      Parameters:
      edgeEnablerRecordTypes - array of edge enabler types
      Returns:
      the edge enabler form
      Throws:
      NullArgumentException - edgeEnablerRecordTypes 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.

    • createEdgeEnabler

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

    • canUpdateEdgeEnablers

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

    • getEdgeEnablerFormForUpdate

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

    • updateEdgeEnabler

      void updateEdgeEnabler(EdgeEnablerForm edgeEnablerForm) throws OperationFailedException, PermissionDeniedException
      Updates an existing edge enabler.
      Parameters:
      edgeEnablerForm - the form containing the elements to be updated
      Throws:
      IllegalStateException - edgeEnablerForm already used in an update transaction
      InvalidArgumentException - the form contains an invalid value
      NullArgumentException - edgeEnablerId or edgeEnablerForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - edgeEnablerForm did not originate from getEdgeEnablerFormForUpdate()
      Compliance:
      mandatory - This method must be implemented.

    • canDeleteEdgeEnablers

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

    • deleteEdgeEnabler

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

    • canManageEdgeEnablerAliases

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

    • aliasEdgeEnabler

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