Package com.inrupt.client.accessgrant

Class AccessRequest.RequestParameters.Builder

java.lang.Object
com.inrupt.client.accessgrant.AccessRequest.RequestParameters.Builder
Enclosing class:
AccessRequest.RequestParameters
public static class AccessRequest.RequestParameters.Builder extends Object
A class for building access request parameters.

  • Method Details

    • recipient

      public AccessRequest.RequestParameters.Builder recipient(URI recipient)
      Set a recipient for the access request operation.

      Note: this will typically be the identifier of resource owner

      Parameters:
      recipient - the recipient identifier, may be null
      Returns:
      this builder

    • resource

      public AccessRequest.RequestParameters.Builder resource(URI resource)
      Set a single resource for the access request operation.
      Parameters:
      resource - the resource identifier, not null
      Returns:
      this builder

    • resources

      public AccessRequest.RequestParameters.Builder resources(Collection<URI> resources)
      Set multiple resources for the access request operation.

      Note: A null value will clear all existing resource values

      Parameters:
      resources - the resource identifiers, may be null
      Returns:
      this builder

    • mode

      public AccessRequest.RequestParameters.Builder mode(String mode)
      Set a single access mode for the access request operation.
      Parameters:
      mode - the access mode, not null
      Returns:
      this builder

    • modes

      public AccessRequest.RequestParameters.Builder modes(Collection<String> modes)
      Set multiple access modes for the access request operation.

      Note: A null value will clear all existing mode values

      Parameters:
      modes - the access modes, may be null
      Returns:
      this builder

    • purpose

      public AccessRequest.RequestParameters.Builder purpose(URI purpose)
      Set a single purpose for the access request operation.
      Parameters:
      purpose - the purpose identifier, not null
      Returns:
      this builder

    • purposes

      public AccessRequest.RequestParameters.Builder purposes(Collection<URI> purposes)
      Set multiple purposes for the access request operation.

      Note: A null value will clear all existing purpose values

      Parameters:
      purposes - the purpose identifiers, may be null
      Returns:
      this builder

    • expiration

      public AccessRequest.RequestParameters.Builder expiration(Instant expiration)
      Set a preferred expiration time for the access request operation.

      Note: an access grant server may select a different expiration value

      Parameters:
      expiration - the expiration time, may be null.
      Returns:
      this builder

    • issuedAt

      public AccessRequest.RequestParameters.Builder issuedAt(Instant issuedAt)
      Set a preferred issuance time for the access request operation, likely at a time in the future.

      Note: an access grant server may select a different issuance value

      Parameters:
      issuedAt - the issuance time, may be null.
      Returns:
      this builder

    • build

      public AccessRequest.RequestParameters build()
      Build the AccessRequest.RequestParameters object.
      Returns:
      the access request parameters