AuthenticationResourceReference (XWiki Platform - Security - Authentication - API 14.8-rc-1 API)

java.lang.Object
- org.xwiki.resource.AbstractResourceReference
- - org.xwiki.security.authentication.AuthenticationResourceReference

All Implemented Interfaces:

ResourceReference
```
@Unstable
public class AuthenticationResourceReference
extends AbstractResourceReference
```
A dedicated ResourceReference to perform authentication related actions. See AuthenticationAction for the possible actions.

Since:

13.1RC1

Version:

$Id: 30d1668314659c7f2ba231ba11b3b79c1096078b $

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`RESOURCE_TYPE_ID`	Identifier of the resource type also used for associated components.
`static ResourceType`	`TYPE`	Dedicated resource type used for authentication.

Constructor Summary

Constructors
Constructor Description

AuthenticationResourceReference(WikiReference wikiReference, AuthenticationAction action)
Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`AuthenticationAction`	`getAction()`
`WikiReference`	`getWikiReference()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class org.xwiki.resource.AbstractResourceReference
addParameter, getParameters, getParameterValue, getParameterValues, getType, setParameter, setType

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

- Field Detail
  - RESOURCE_TYPE_ID
```
public static final String RESOURCE_TYPE_ID
```
    Identifier of the resource type also used for associated components.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final ResourceType TYPE
```
    Dedicated resource type used for authentication.
- Constructor Detail
  - AuthenticationResourceReference
```
public AuthenticationResourceReference(WikiReference wikiReference,
                                       AuthenticationAction action)
```
    Default constructor.
    
    Parameters:
    
    wikiReference - the reference of the wiki where the action should be performed.
    
    action - the action to perform.
- Method Detail
  - getAction
```
public AuthenticationAction getAction()
```
    Returns:
    
    the action associated to this resource reference.
  - getWikiReference
```
public WikiReference getWikiReference()
```
    Returns:
    
    the reference of the wiki where the action should be performed.
    
    Since:
    
    14.6RC1, 14.4.3, 13.10.8
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class AbstractResourceReference
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractResourceReference
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractResourceReference