CustomAuthenticator (commons-net 1.2.13-SNAPSHOT API)

java.lang.Object
- java.net.Authenticator
- - de.unkrig.commons.net.authenticator.CustomAuthenticator

```
public class CustomAuthenticator
extends Authenticator
```
An Authenticator that can be installed into the running JVM by calling Authenticator.setDefault(Authenticator).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CustomAuthenticator.CacheMode` Whether user names, user names and passwords, or none of both are remembered while the JVM is running.
`static class`	`CustomAuthenticator.CredentialsSpec` A pattern that is intended to be matched against the properties of an `Authenticator`.
`static class`	`CustomAuthenticator.StoreMode` Whether user names, user names and passwords, or none of both are persistently stored.

Nested classes/interfaces inherited from class java.net.Authenticator
Authenticator.RequestorType

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_DIALOG_LABEL
The dialog label to take effect iff no custom label is configured through setDialogLabel(String).

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_DIALOG_LABEL` The dialog label to take effect iff no custom label is configured through `setDialogLabel(String)`.

Constructor Summary

Constructors
Constructor and Description

CustomAuthenticator(CustomAuthenticator.CacheMode cacheMode, CustomAuthenticator.StoreMode storeMode)

Constructors
Constructor and Description
`CustomAuthenticator(CustomAuthenticator.CacheMode cacheMode, CustomAuthenticator.StoreMode storeMode)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCredentials(Collection<CustomAuthenticator.CredentialsSpec> credentials)` Adds a set of `CustomAuthenticator.CredentialsSpec`s to this `CustomAuthenticator`.
`protected PasswordAuthentication`	`getPasswordAuthentication()`
`void`	`setDialogLabel(String message)` The text of the label in the authentication dialog, in `MessageFormat` format.

Methods inherited from class java.net.Authenticator
getRequestingHost, getRequestingPort, getRequestingPrompt, getRequestingProtocol, getRequestingScheme, getRequestingSite, getRequestingURL, getRequestorType, requestPasswordAuthentication, requestPasswordAuthentication, requestPasswordAuthentication, setDefault

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

- Field Detail
  - DEFAULT_DIALOG_LABEL
```
public static final String DEFAULT_DIALOG_LABEL
```
    The dialog label to take effect iff no custom label is configured through setDialogLabel(String).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CustomAuthenticator
```
public CustomAuthenticator(CustomAuthenticator.CacheMode cacheMode,
                           CustomAuthenticator.StoreMode storeMode)
```
    Parameters:
    
    cacheMode - Whether user names, user names and passwords, or none of both are remembered while the JVM is running
    
    storeMode - Whether user names, user names and passwords, or none of both are persistently stored
- Method Detail
  - setDialogLabel
```
public void setDialogLabel(String message)
```
    The text of the label in the authentication dialog, in MessageFormat format.
    The following arguments are replaced within the message:
    
    {0}
    
    The "key" to the authentication, which is composed like this:
    requestor-type/requesting-protocol/requesting-host/requesting-port/requesting-scheme/
    Example value: "PROXY/http/proxy.company.com/8080/Negotiate"
    
    {1}, {2}^*
    
    The requesting host; see Authenticator.getRequestingHost()
    
    {3}, {4}^*
    
    The requesting site; see Authenticator.getRequestingSite()
    
    {5}, {6}^*
    
    The requesting port; see Authenticator.getRequestingPort()
    
    {7}, {8}^*
    
    The requesting protocol; see Authenticator.getRequestingProtocol()
    
    {9}, {10}^*
    
    The requesting prompt; see Authenticator.getRequestingPrompt()
    
    {11}, {12}^*
    
    The requesting scheme; see Authenticator.getRequestingScheme()
    
    {13}, {14}^*
    
    The requesting URL; see Authenticator.getRequestingURL()
    
    {15}, {16}^*
    
    The requestor type; see Authenticator.getRequestorType()
    
    ^* Where the above list presents two placeholders, they expand as follows:
    - If the value is either null or "" or -1, the two placeholders expand to "0" and "".
    - Otherwise, the two placeholders expand to "1" and the value.
    The default value is
```
 <html>
   <table>
     {1,  choice, 0#|1#'<tr><td>Host:    </td><td>'{2}'</td></tr>'}
     {3,  choice, 0#|1#'<tr><td>Site:    </td><td>'{4}'</td></tr>'}
     {5,  choice, 0#|1#'<tr><td>Port:    </td><td>'{6}'</td></tr>'}
     {7,  choice, 0#|1#'<tr><td>Protocol:</td><td>'{8}'</td></tr>'}
     {9,  choice, 0#|1#'<tr><td>Prompt:  </td><td>'{10}'</td></tr>'}
     {11, choice, 0#|1#'<tr><td>Scheme:  </td><td>'{12}'</td></tr>'}
     {13, choice, 0#|1#'<tr><td>URL:     </td><td>'{14}'</td></tr>'}
     {15, choice, 0#|1#'<tr><td>Type:    </td><td>'{16}'</td></tr>'}
   </table>
 </html>
 
```
  - addCredentials
```
public void addCredentials(Collection<CustomAuthenticator.CredentialsSpec> credentials)
```
    Adds a set of CustomAuthenticator.CredentialsSpecs to this CustomAuthenticator. Earlier specs take precedence over later specs.
    Specs that equal any previously added spec are ignored, because they are irrelevant.
    
    If no specs are added, then the CustomAuthenticator will prompt the user for user name and/or password, and optionally cache the entered data (transiently and/or persistently, depending on the configured cache mode and store mode).
    
    See Also:
    
    CustomAuthenticator(CacheMode, StoreMode)
  - getPasswordAuthentication
```
@Nullable
protected PasswordAuthentication getPasswordAuthentication()
```
    Overrides:
    
    getPasswordAuthentication in class Authenticator

Class CustomAuthenticator

Nested Class Summary

Nested classes/interfaces inherited from class java.net.Authenticator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.net.Authenticator

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DIALOG_LABEL

Constructor Detail

CustomAuthenticator

Method Detail

setDialogLabel

addCredentials

getPasswordAuthentication