AnonymousLoginModule (Apache JSPWiki 2.11.2 API)

java.lang.Object
- org.apache.wiki.auth.login.AbstractLoginModule
- - org.apache.wiki.auth.login.AnonymousLoginModule

All Implemented Interfaces:

javax.security.auth.spi.LoginModule
```
public class AnonymousLoginModule
extends AbstractLoginModule
```
Logs in a user based solely on IP address; no other authentication is performed. Barring a mis-configuration or I/O error, this LoginModule always succeeds.
This module must be used with a CallbackHandler (such as WebContainerCallbackHandler) that supports the following Callback types:
1. HttpRequestCallback- supplies the IP address, which is used as a backup in case no name is supplied.
After authentication, a generic WikiPrincipal based on the IP address will be created and associated with the Subject.
Since:

2.3

See Also:

LoginModule.commit()

Field Summary

Fields
Modifier and Type Field Description

protected static org.apache.logging.log4j.Logger log

static java.lang.String PROMPT
Bogus prompt sent to the callback handler.
- Fields inherited from class org.apache.wiki.auth.login.AbstractLoginModule
  m_handler, m_options, m_principals, m_state, m_subject, NULL

Constructor Summary

Constructors
Constructor Description

AnonymousLoginModule()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`login()`	Logs in the user by calling back to the registered CallbackHandler with a series of callbacks.

Methods inherited from class org.apache.wiki.auth.login.AbstractLoginModule
abort, commit, initialize, logout

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

- Field Detail
  - PROMPT
```
public static final java.lang.String PROMPT
```
    Bogus prompt sent to the callback handler.
    
    See Also:
    
    Constant Field Values
  - log
```
protected static final org.apache.logging.log4j.Logger log
```
- Constructor Detail
  - AnonymousLoginModule
```
public AnonymousLoginModule()
```
- Method Detail
  - login
```
public boolean login()
              throws javax.security.auth.login.LoginException
```
    Logs in the user by calling back to the registered CallbackHandler with a series of callbacks. If the login succeeds, this method returns true Logs in the user by calling back to the registered CallbackHandler with an HttpRequestCallback. The CallbackHandler must supply the current servlet HTTP request as its response.
    
    Specified by:
    
    login in interface javax.security.auth.spi.LoginModule
    
    Specified by:
    
    login in class AbstractLoginModule
    
    Returns:
    
    the result of the login; this will always be true.
    
    Throws:
    
    javax.security.auth.login.LoginException - if unable to handle callback
    
    See Also:
    
    LoginModule.login()