Package org.apache.juneau.rest.server.auth

Class BearerTokenGuard.Builder

java.lang.Object

org.apache.juneau.rest.server.auth.BearerTokenGuard.Builder

Enclosing class:

BearerTokenGuard

public static class BearerTokenGuard.Builder
extends Object

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
BearerTokenGuard	build()	Builds the guard.
BearerTokenGuard.Builder	realm(String value)	Sets the WWW-Authenticate: Bearer realm="<value>" challenge realm.
BearerTokenGuard.Builder	validator(TokenValidator value)	Sets the token validator the guard delegates to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

protected Builder()

Constructor.

Method Details

validator

public BearerTokenGuard.Builder validator(TokenValidator value)

Sets the token validator the guard delegates to.

Parameters:

value - The validator. Must not be null.

Returns:

This object.

realm

public BearerTokenGuard.Builder realm(String value)

Sets the WWW-Authenticate: Bearer realm="<value>" challenge realm.

The realm string communicates to the client which protection space the credentials apply to. Defaults to "api" when not set.

Parameters:

value - The realm. Must not be null or blank.

Returns:

This object.

build

public BearerTokenGuard build()

Builds the guard.

Returns:

A new BearerTokenGuard.