Property Detail

• static final java.lang.String API_KEY_HEADER_NAME

• static final java.util.List<java.lang.String> LOOPBACK_ADDRESSES

• static final int STATUS_UNAUTHORISED

• ApiKeyService apiKeyService

• @org.springframework.beans.factory.annotation.Autowired(required = false) org.pac4j.http.client.direct.DirectBearerAuthClient bearerAuthClient

• @org.springframework.beans.factory.annotation.Autowired(required = false) org.pac4j.core.config.Config config

• grails.core.GrailsApplication grailsApplication

• @org.springframework.beans.factory.annotation.Autowired au.org.ala.ws.security.JwtProperties jwtProperties

Constructor Detail

• ApiKeyInterceptor()

Method Detail

• boolean after()

  Executed after the action executes but prior to view rendering

  Returns:

  True if view rendering should continue, false otherwise

• void afterView()

  Executed after view rendering completes

• boolean before()

  Executed before a matched action

  Returns:

  Whether the action should continue and execute

• java.util.List<java.lang.String> buildWhiteList()

• java.lang.Object checkClientIp(java.lang.Object clientIp, java.util.List<java.lang.String> whiteList)

  Client IP passes if it is in the whitelist

  Parameters:

  clientIp

  Returns:

• java.lang.Object getClientIP(javax.servlet.http.HttpServletRequest request)

• @javax.annotation.PostConstruct java.lang.Object init()

• boolean jwtApiKeyInterceptor(RequireApiKey requireApiKey, boolean fallbackToLegacy)

  Validate a JWT Bearer token instead of the API key.

  Parameters:

  requireApiKey - The RequireApiKey annotation

  fallbackToLegacy - Whether to fall back to legacy API keys if the JWT is not present.

  Returns:

  true if the request is authorised

• boolean legacyApiKeyInterceptor()