Property Detail

• static java.lang.Object LOGGED_IN_CLASS

• static java.lang.Object LOGGED_OUT_CLASS

• @org.springframework.beans.factory.annotation.Value('${ala.baseURL:https://www.ala.org.au}') java.lang.String alaBaseURL

  All the following defaults can be overridden by the specified config declarations. The banner include assumes that ala-cas-client exists in the app library.

• @org.springframework.beans.factory.annotation.Value('${bie.baseURL:https://bie.ala.org.au}') java.lang.String bieBaseURL

• @org.springframework.beans.factory.annotation.Value('${bie.searchPath:https://bie.ala.org.au}') java.lang.String bieSearchPath

• @org.springframework.beans.factory.annotation.Value('${headerAndFooter.cacheTimeout:1800000}') java.lang.Long cacheTimeout

• @org.springframework.beans.factory.annotation.Value('${security.cas.loginUrl:https://auth.ala.org.au/cas/login}') java.lang.String casLoginUrl

• @org.springframework.beans.factory.annotation.Value('${security.cas.logoutUrl:https://auth.ala.org.au/cas/login}') java.lang.String casLogoutUrl

• org.grails.encoder.CodecLookup codecLookup

• @org.springframework.beans.factory.annotation.Value('${fathom.site-id}') java.lang.String fathomSiteId

• @org.springframework.beans.factory.annotation.Value('${grails.serverURL:https://bie.ala.org.au}') java.lang.String grailServerURL

• @org.springframework.beans.factory.annotation.Autowired grails.web.mapping.LinkGenerator grailsLinkGenerator

• @org.springframework.beans.factory.annotation.Value('${headerAndFooter.baseURL:https://www.ala.org.au/commonui-bs3}') java.lang.String headerAndFooterBaseURL

• @org.springframework.beans.factory.annotation.Value('${headerAndFooter.version:2}') java.lang.String headerAndFooterVersion

• java.lang.Object hfCache

  Cache for includes. Expires after 30 mins or when clearCache is called.

• @org.springframework.beans.factory.annotation.Value('${security.oidc.enabled:false}') java.lang.Boolean isOidc

• @org.springframework.beans.factory.annotation.Value('${userDetails.url:https://auth.ala.org.au/userdetails}') java.lang.String userDetailsServerUrl

Method Detail

• java.lang.String buildEditAccountLink(java.lang.Object request, java.util.Map attrs)

• java.lang.String buildLoginLink(java.lang.Object request, java.util.Map attrs = [:])

  Build the login link

  Parameters:

  request - The current web request.

  attrs - any specified params to override defaults

  Returns:

  The login url

• java.lang.String buildLoginUrl(javax.servlet.http.HttpServletRequest request, java.lang.String customCasLoginUrl = null, java.lang.String customLoginReturnToUrl = null)

  Build a login url.

  Parameters:

  request - The current request.

  customCasLoginUrl - A custom CAS login url. Leave null to use the default.

  customLoginReturnToUrl - A custom login return to url. Leave null to use the current request forward uri.

  Returns:

  A login url with the service url properly encoded.

• java.lang.String buildLoginoutLink(java.lang.Object request, java.util.Map attrs)

  Builds the login or logout link based on current login status.

  Parameters:

  attrs - any specified params to override defaults

  Returns:

• java.lang.String buildLoginoutLinkV1(java.lang.Object request, java.lang.Object attrs)

  deprecated:

  Builds the login or logout link based on current login status.

  Parameters:

  attrs - any specified params to override defaults

  Returns:

• java.lang.String buildLoginoutLinkV2(java.lang.Object request, java.lang.Object attrs)

  Builds the login or logout link based on current login status.

  Parameters:

  attrs - any specified params to override defaults

  Returns:

• java.lang.String buildLogoutLink(java.lang.Object request, java.util.Map attrs)

  Build the logout link

  Parameters:

  attrs - any specified params to override defaults

  Returns:

  The logout url

• java.lang.String buildLogoutUrl(javax.servlet.http.HttpServletRequest request, java.lang.String customCasLogoutUrl = null, java.lang.String customLogoutUrl = null, java.lang.String customLogoutReturnToUrl = null)

  Build a logout url.

  Parameters:

  request - The current request.

  customCasLogoutUrl - A custom CAS login url. Leave null to use the default.

  customLogoutUrl - A custom logout url. Leave blank to use the default.

  customLogoutReturnToUrl - A custom logout return to url. Leave null to use the current request forward uri.

  Returns:

  A logout url.

• java.lang.String buildMyProfileLink(java.lang.Object request, java.util.Map attrs)

• java.lang.String buildRequestForwardUrl(javax.servlet.http.HttpServletRequest request)

  Build a url that forwards to request.forwardURI.

  Parameters:

  request

  Returns:

  The built url.

• java.lang.String buildUri(java.lang.String baseUri, java.util.List pathSegments = null, java.util.Map<java.lang.String, java.lang.Object> queryParameters = null, java.lang.String fragment = null, java.util.Map<java.lang.String, ?> uriVariables = null)

  Build a uri from a base uri, additional optional path segments, additional optional query parameters, optional fragment and optional uri variables to expand placeholders. Ensures the resulting uri correctly encodes the parts of the uri.

  Parameters:

  baseUri - The base uri.

  pathSegments - Path segments to be added to the base uri.

  queryParameters - Query parameters to be added to the base uri. Existing query parameters that match new query parameters will be replaced.

  fragment - The new fragment, will replace any existing fragment

  Returns:

  Built uri string.

• java.lang.Object clearCache()

  Clear the in-memory cache of content fragments.

  Returns:

• java.lang.String contentBasedOnCurrentUser(java.lang.Object request, java.lang.String content, java.util.Map attrs)

  Add content based on whether the current user is logged in or not.

  Parameters:

  request - The current request.

  content - The content to add.

  attrs - The tag attributes.

  Returns:

  The modified content.

• java.lang.String getContent(java.lang.String which)

  Loads the content from the web.

  Parameters:

  which - specifies the include

  Returns:

• boolean isLoggedIn(java.lang.Object request, java.lang.Object attrs)

  Determine whether the current request has a logged in user or not.

  Parameters:

  request - The current request.

  attrs - The tag attributes.

  Returns:

  True if there is a logged in user, otherwise false.

• java.lang.String load(java.lang.String which, java.lang.Object request, java.util.Map attrs)

  Get the content from cache of the web.

  Parameters:

  which - specifies the include

  attrs - any specified params

  Returns:

• java.lang.String transform(java.lang.Object request, java.lang.String content, java.util.Map attrs)

  Does the appropriate substitutions on the included content.

  Parameters:

  content

  attrs - any specified params to override defaults

  Returns:

• java.lang.String transformV1(java.lang.Object request, java.lang.Object content, java.lang.Object attrs)

  deprecated:

  Does the appropriate substitutions on the included content.

  Parameters:

  content

  attrs - any specified params to override defaults

  Returns:

• java.lang.String transformV2(java.lang.Object request, java.lang.Object content, java.lang.Object attrs)

  Does the appropriate substitutions on the included content.

  Parameters:

  content

  attrs - any specified params to override defaults

  Returns: