FormAuthContextBuilder (FORMCYCLE: BOM 7.3.0 API)

java.lang.Object
- de.xima.fc.web.common.auth.FormAuthContextBuilder

```
public class FormAuthContextBuilder
extends Object
```
Builder for creating an IFormAuthContext

Author:

XIMA MEDIA GmbH

Field Summary

Fields
Modifier and Type	Field	Description
`protected javax.servlet.http.HttpServletRequest`	`request`
`protected javax.servlet.http.HttpServletResponse`	`response`
`protected FRQSession`	`session`

Constructor Summary

Constructors
Constructor	Description
`FormAuthContextBuilder(IExtendedFormRequestContext requestCtx)`	Constructor for creating the builder based on an `IExtendedFormRequestContext`
`FormAuthContextBuilder(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)`	Constructor for creating the builder based on an servlet request

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`IFormAuthContext`	`build()`	Builds the `IFormAuthContext`
`FormAuthContextBuilder`	`forceAuthType(EAuthClientType type)`
`FormAuthContextBuilder`	`withAuthenticatorToken(String authenticatorToken)`	Deprecated. The authenticator token should be determined by the pac4j through the request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

request

protected javax.servlet.http.HttpServletRequest request

response

protected javax.servlet.http.HttpServletResponse response

session
```
protected FRQSession session
```

Constructor Detail
- FormAuthContextBuilder
```
public FormAuthContextBuilder(IExtendedFormRequestContext requestCtx)
```
  Constructor for creating the builder based on an IExtendedFormRequestContext
  
  Parameters:
  
  requestCtx - the IExtendedFormRequestContext
- FormAuthContextBuilder
```
public FormAuthContextBuilder(javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse resp)
```
  Constructor for creating the builder based on an servlet request
  
  Parameters:
  
  req - HttpServletRequest
  
  resp - HttpServletResponse

Method Detail

withAuthenticatorToken
```
@Deprecated
public FormAuthContextBuilder withAuthenticatorToken(String authenticatorToken)
```
Deprecated.
The authenticator token should be determined by the pac4j through the request.

forceAuthType

public FormAuthContextBuilder forceAuthType(EAuthClientType type)

build
```
public IFormAuthContext build()
```
Builds the IFormAuthContext

Returns:

IFormAuthContext