## Uses of Interface
com.holonplatform.auth.Authentication

- Packages that use Authentication
  Package | Description
  --- | ---
  com.holonplatform.auth |
  com.holonplatform.auth.jwt |

- - ### Uses of Authentication in com.holonplatform.auth

    Methods in com.holonplatform.auth that return Authentication
    Modifier and Type | Method and Description
    --- | ---
    `Authentication` | AuthContext.`authenticate(AuthenticationToken authenticationToken)` Attempts to authenticate a user using given `AuthenticationToken`.
    `Authentication` | Authenticator.MessageAuthenticator.`authenticate(Message<?,?> message, String... schemes)` Try to authenticate given `message` with the same contract as `Authenticator.authenticate(AuthenticationToken)`.
    `Authentication` | AuthContext.`authenticate(Message<?,?> message, String... schemes)` Attempts to authenticate using given `message` with the same contract as `AuthContext.authenticate(AuthenticationToken)`, using `Realm` registered `AuthenticationToken.AuthenticationTokenResolver`s for given message type, if any.
    `Authentication` | Authenticator.`authenticate(T authenticationToken)` Attempts to perform authentication using given `AuthenticationToken`.
    `Authentication` | Authentication.Builder.`build()` Create Authentication instance

    Methods in com.holonplatform.auth that return types with arguments of type Authentication
    Modifier and Type | Method and Description
    --- | ---
    `Optional<Authentication>` | AuthContext.`getAuthentication()` Get current Authentication in this context.
    `Optional<Authentication>` | AuthContext.`unauthenticate()` Unbound current `Authentication` from this AuthContext, if any

    Methods in com.holonplatform.auth with parameters of type Authentication
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | Authorizer.`isPermitted(Authentication authentication, Collection<P> permissions)` Check if given Authentication has all specified permission/s using a Collection
    `boolean` | Authorizer.`isPermitted(Authentication authentication, P... permissions)` Check if given Authentication has all specified permission/s
    `boolean` | Authorizer.`isPermitted(Authentication authentication, String... permissions)` Check if given Authentication has all specified permission/s using String permission form.
    `boolean` | Authorizer.`isPermittedAny(Authentication authentication, Collection<P> permissions)` Check if given Authentication has any of specified permission/s using a Collection
    `boolean` | Authorizer.`isPermittedAny(Authentication authentication, P... permissions)` Check if given Authentication has any of specified permission/s
    `boolean` | Authorizer.`isPermittedAny(Authentication authentication, String... permissions)` Check if given Authentication has any of specified permission/s using String permission form.
    `void` | Authentication.AuthenticationListener.`onAuthentication(Authentication authentication)` Called when an authentication or deauthentication event occurs.

  - ### Uses of Authentication in com.holonplatform.auth.jwt

    Methods in com.holonplatform.auth.jwt with parameters of type Authentication
    Modifier and Type | Method and Description
    --- | ---
    `static String` | JwtTokenBuilder.`buildJWT(Authentication authentication, String id, String issuer, Long timeToLiveMs, JwtTokenBuilder.AuthPart... includeParts)` Build a not signed JSON Web Token form given `Authentication`
    `static String` | JwtTokenBuilder.`buildJWT(Authentication authentication, String id, String issuer, Long timeToLiveMs, io.jsonwebtoken.SignatureAlgorithm algorithm, byte[] signingKey, JwtTokenBuilder.AuthPart... includeParts)` Build a JSON Web Token form given `Authentication`
    `static String` | JwtTokenBuilder.`buildJWT(Authentication authentication, String id, String issuer, Long timeToLiveMs, io.jsonwebtoken.SignatureAlgorithm algorithm, Key privateKey, JwtTokenBuilder.AuthPart... includeParts)` Build a JSON Web Token form given `Authentication`
    `static String` | JwtTokenBuilder.`buildJWT(Authentication authentication, String id, String issuer, Long timeToLiveMs, io.jsonwebtoken.SignatureAlgorithm algorithm, String base64EncodedKey, JwtTokenBuilder.AuthPart... includeParts)` Build a JSON Web Token form given `Authentication`
    `static String` | JwtTokenBuilder.`buildJwtToken(JwtConfiguration configuration, Authentication authentication, String jwtTokenId)` Build a JWT token using given `JwtConfiguration` for given `Authentication`.

Copyright © 2017 The Holon Platform. All rights reserved.