CustomAuthenticator.CredentialsSpec (commons-net 1.2.13-SNAPSHOT API)

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

All Implemented Interfaces:

Destroyable

Enclosing class:

CustomAuthenticator
```
public static final class CustomAuthenticator.CredentialsSpec
extends Object
implements Destroyable
```
A pattern that is intended to be matched against the properties of an Authenticator.

Constructor Summary

Constructors
Constructor and Description

CredentialsSpec()

Constructors
Constructor and Description
`CredentialsSpec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()`
`boolean`	`equals(Object obj)`
`protected void`	`finalize()`
`int`	`hashCode()`
`boolean`	`isDestroyed()`
`void`	`setDeny(boolean value)` If set to `true`, then `setUserName(String)` and `setPassword(char[])` are ignored, and authentication is denied for this spec.
`void`	`setPassword(char[] password)` The password to use iff this `<credentials>` element matches.
`void`	`setRequestingHost(Pattern regex)` The pattern to match against the hostname of the site or proxy.
`void`	`setRequestingPort(Pattern regex)` The pattern to match against "the port number for the requested connection".
`void`	`setRequestingPrompt(Pattern regex)` The pattern to match against "the prompt string given by the requestor (the "realm" for HTTP authentication)".
`void`	`setRequestingProtocol(Pattern regex)` The pattern to match against "the protocol that's requesting the connection".
`void`	`setRequestingScheme(Pattern regex)` The pattern to match against "the scheme of the requestor".
`void`	`setRequestingSite(Pattern regex)` The pattern to match against the `InetAddress` of the site.
`void`	`setRequestingUrl(Pattern regex)` The pattern to match against "the URL that resulted in this request for authentication".
`void`	`setRequestorType(Pattern regex)` Whether the requestor is a Proxy or a Server.
`void`	`setUserName(String userName)` The user name to use iff this `<credentials>` element matches.

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

- Constructor Detail
  - CredentialsSpec
```
public CredentialsSpec()
```
- Method Detail
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class Object
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface Destroyable
  - isDestroyed
```
public boolean isDestroyed()
```
    Specified by:
    
    isDestroyed in interface Destroyable
  - setRequestingHost
```
public void setRequestingHost(@Nullable
                              Pattern regex)
```
    The pattern to match against the hostname of the site or proxy. null (the default) means "any host".
  - setRequestingSite
```
public void setRequestingSite(@Nullable
                              Pattern regex)
```
    The pattern to match against the InetAddress of the site. null (the default) means "any site".
  - setRequestingPort
```
public void setRequestingPort(@Nullable
                              Pattern regex)
```
    The pattern to match against "the port number for the requested connection". null (the default) means "any port".
  - setRequestingProtocol
```
public void setRequestingProtocol(@Nullable
                                  Pattern regex)
```
    The pattern to match against "the protocol that's requesting the connection". null (the default) means "any protocol".
  - setRequestingPrompt
```
public void setRequestingPrompt(@Nullable
                                Pattern regex)
```
    The pattern to match against "the prompt string given by the requestor (the "realm" for HTTP authentication)". null (the default) means "any prompt string".
  - setRequestingScheme
```
public void setRequestingScheme(@Nullable
                                Pattern regex)
```
    The pattern to match against "the scheme of the requestor". null (the default) means "any scheme".
  - setRequestingUrl
```
public void setRequestingUrl(@Nullable
                             Pattern regex)
```
    The pattern to match against "the URL that resulted in this request for authentication". null (the default) means "any URL".
  - setRequestorType
```
public void setRequestorType(@Nullable
                             Pattern regex)
```
    Whether the requestor is a Proxy or a Server.
    
    PROXY
    
    Entity requesting authentication is a HTTP proxy server.
    
    SERVER
    
    Entity requesting authentication is a HTTP origin server.
    
    null (the default) means "any requestor type".
  - setDeny
```
public void setDeny(boolean value)
```
    If set to true, then setUserName(String) and setPassword(char[]) are ignored, and authentication is denied for this spec. The default is "false".
  - setUserName
```
public void setUserName(@Nullable
                        String userName)
```
    The user name to use iff this <credentials> element matches.
  - setPassword
```
public void setPassword(@Nullable
                        char[] password)
```
    The password to use iff this <credentials> element matches.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(@Nullable
                      Object obj)
```
    Overrides:
    
    equals in class Object

Class CustomAuthenticator.CredentialsSpec

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CredentialsSpec

Method Detail

finalize

destroy

isDestroyed

setRequestingHost

setRequestingSite

setRequestingPort

setRequestingProtocol

setRequestingPrompt

setRequestingScheme

setRequestingUrl

setRequestorType

setDeny

setUserName

setPassword

hashCode

equals