Skip navigation links
A B C D E F G H I L M N O P R S T U V W 

A

ACCESSURL_PARAM - Static variable in class uk.ac.starlink.auth.GenericCookieAuthScheme
Name of challenge parameter giving login URL.
ACCESSURL_PARAM - Static variable in class uk.ac.starlink.auth.IvoaAuthScheme
 
AUTH_HEADER - Static variable in class uk.ac.starlink.auth.AuthUtil
RFC7235 Authorization header key "Authorization" (RFC 7235 sec 4.2).
authcheck(URL, boolean, boolean) - Method in class uk.ac.starlink.auth.AuthManager
Attempts to establish authentication for an authcheck-type URL.
AuthConnection - Class in uk.ac.starlink.auth
Aggregates a URLConnection and the AuthContext used to make the connection.
AuthConnection(URLConnection, AuthContext) - Constructor for class uk.ac.starlink.auth.AuthConnection
Constructor.
AuthContext - Interface in uk.ac.starlink.auth
An object which is capable of manipulating HTTP connections to add required authentication information.
authFailureMessage(HttpURLConnection) - Static method in class uk.ac.starlink.auth.AuthUtil
Prepares a short user-readable message indicating the state of a connection that failed because of auth issues.
AUTHID_HEADER - Static variable in class uk.ac.starlink.auth.AuthUtil
Header giving user authenticated ID "X-VO-Authenticated" (SSO).
AuthManager - Class in uk.ac.starlink.auth
Manages authentication.
AuthManager(UserInterface, AuthScheme[], Redirector) - Constructor for class uk.ac.starlink.auth.AuthManager
Constructor.
AuthScheme - Interface in uk.ac.starlink.auth
Represents an RFC7235 authentication scheme.
AuthStatus - Class in uk.ac.starlink.auth
Characterises the authenticate associated with a connection.
AuthStatus(AuthType) - Constructor for class uk.ac.starlink.auth.AuthStatus
Constructs an AuthStatus with a given type but no actual authentication.
AuthStatus(AuthType, boolean, String) - Constructor for class uk.ac.starlink.auth.AuthStatus
Constructs an AuthStatus with given characteristics.
AuthTest - Class in uk.ac.starlink.auth
 
AuthTest() - Constructor for class uk.ac.starlink.auth.AuthTest
 
AuthType - Enum in uk.ac.starlink.auth
Enumerates different types of authentication available for a connection.
AuthUtil - Class in uk.ac.starlink.auth
Utilities used by authentication classes.

B

BadChallengeException - Exception in uk.ac.starlink.auth
Exception indicating that an authentication challenge is badly formed, for instance missing parameters required by the scheme to which it is supposed to conform.
BadChallengeException(String) - Constructor for exception uk.ac.starlink.auth.BadChallengeException
Constructor.
BadChallengeException(String, Throwable) - Constructor for exception uk.ac.starlink.auth.BadChallengeException
Constructor.
base64Encode(byte[]) - Static method in class uk.ac.starlink.auth.AuthUtil
Converts a byte array to its BASE64 encoded form.
BASIC_AA - Static variable in class uk.ac.starlink.auth.IvoaLoginProtocol
Implementation for standard_id="ivo://ivoa.net/sso#BasicAA".
BasicAuthScheme - Class in uk.ac.starlink.auth
Implements HTTP Basic Authentication as defined in RFC7617.
BearerIvoaAuthScheme - Class in uk.ac.starlink.auth
IvoaAuthScheme concrete subclass for working with bearer tokens.

C

CadcAuthScheme - Class in uk.ac.starlink.auth
AuthScheme implementation that works (at time of writing) with the implementation of the CADC services.
canRetry() - Method in class uk.ac.starlink.auth.UserInterface
Indicates whether there is any point in repeated attempts to acquire credentials from the user.
Challenge - Class in uk.ac.starlink.auth
Represents and parses challenge specifications as defined by RFC7235.
Challenge(String, String, Map<String, String>) - Constructor for class uk.ac.starlink.auth.Challenge
Constructs a challenge with an optional realm and auth parameters.
Challenge(String, String) - Constructor for class uk.ac.starlink.auth.Challenge
Constructs a challenge with token68 string
CHALLENGE_HEADER - Static variable in class uk.ac.starlink.auth.AuthUtil
RFC 7235 challenge header key "WWW-Authenticate" (RFC 7235 sec 4.1).
clear() - Method in class uk.ac.starlink.auth.AuthManager
Clears all authentication state from this manager.
CLI - Static variable in class uk.ac.starlink.auth.UserInterface
Command-line instance.
configureConnection(HttpURLConnection) - Method in interface uk.ac.starlink.auth.AuthContext
Configures an HTTP connection with required authentication.
connect(URL) - Method in class uk.ac.starlink.auth.AuthManager
Opens a URL connection to a given URL, negotiating authentication and with default handling of 3xx redirection.
connect(URL, UrlConnector) - Method in class uk.ac.starlink.auth.AuthManager
Opens a URL connection to a given URL with specified configuration, negotiating authentication and with default handling of 3xx redirection.
connect(URL, UrlConnector, Redirector) - Method in class uk.ac.starlink.auth.AuthManager
Opens a URL connection to a given URL with specified configuration, negotiating authentication and with configurable handling of 3xx redirection.
connect(HttpURLConnection) - Method in interface uk.ac.starlink.auth.UrlConnector
Opens communication to an HTTP resource.
ContentType - Class in uk.ac.starlink.auth
Simple abstraction of MIME type.
ContentType(String, String) - Constructor for class uk.ac.starlink.auth.ContentType
Constructs a ContentType from type and subtype strings.
ContextFactory - Interface in uk.ac.starlink.auth
Contains configuration for creating AuthContext objects from user credentials.
CookieIvoaAuthScheme - Class in uk.ac.starlink.auth
IvoaAuthScheme concrete subclass for working with cookies.
cookieLogText(HttpCookie) - Static method in class uk.ac.starlink.auth.AuthUtil
Returns a string suitable for reporting through the logging system to represent a cookie.
createContext(UserInterface) - Method in interface uk.ac.starlink.auth.ContextFactory
Attempts to create an authentication context, by enquiring for input from the UI as appropriate.
createContextFactory(Challenge, URL) - Method in interface uk.ac.starlink.auth.AuthScheme
Attempts to return an object that can take user input to generate an AuthContext based on a given challenge.
createContextFactory(Challenge, URL) - Method in class uk.ac.starlink.auth.BasicAuthScheme
 
createContextFactory(LoginProtocol, URL, URL) - Method in class uk.ac.starlink.auth.BearerIvoaAuthScheme
 
createContextFactory(Challenge, URL) - Method in class uk.ac.starlink.auth.CadcAuthScheme
 
createContextFactory(LoginProtocol, URL, URL) - Method in class uk.ac.starlink.auth.CookieIvoaAuthScheme
 
createContextFactory(Challenge, URL) - Method in class uk.ac.starlink.auth.GacsCookieAuthScheme
 
createContextFactory(Challenge, URL) - Method in class uk.ac.starlink.auth.GenericCookieAuthScheme
 
createContextFactory(Challenge, URL) - Method in class uk.ac.starlink.auth.IvoaAuthScheme
 
createContextFactory(LoginProtocol, URL, URL) - Method in class uk.ac.starlink.auth.IvoaAuthScheme
Creates a ContextFactory for this scheme with a given login protocol instance.
createFixed(String, String) - Static method in class uk.ac.starlink.auth.UserInterface
Returns a headless implementation with a fixed user name and password supplied as strings.
createFixed(UserPass) - Static method in class uk.ac.starlink.auth.UserInterface
Returns a headless implementation with a fixed username+password object.
createStandardInstance(int[]) - Static method in class uk.ac.starlink.auth.Redirector
Returns an instance that redirects on a given list of 3xx codes.
createUnauthContext() - Method in interface uk.ac.starlink.auth.ContextFactory
Creates a context representing unauthenticated (anonymous) access.

D

DEFAULT - Static variable in class uk.ac.starlink.auth.Redirector
Default instance.
DFLT_SCHEMES - Static variable in class uk.ac.starlink.auth.AuthManager
Authentication schemes used by default, in order of preference.

E

encodeUserPass(String, char[]) - Static method in class uk.ac.starlink.auth.BasicAuthScheme
Encodes the user:password pair as a Base64-encoded string, as described by RFC 7617.
equals(Object) - Method in class uk.ac.starlink.auth.Challenge
 
equals(Object) - Method in class uk.ac.starlink.auth.ContentType
 
equals(Object) - Method in class uk.ac.starlink.auth.ProtectionSpace
 
equals(Object) - Method in class uk.ac.starlink.auth.UserPass
 

F

followRedirects(URLConnection, UrlConnector, Redirector) - Method in class uk.ac.starlink.auth.AuthManager
Follows 3xx redirects, applying authentication as required.

G

GacsCookieAuthScheme - Class in uk.ac.starlink.auth
AuthScheme implementation that works with the cookie scheme as prototyped by the GACS system.
GenericCookieAuthScheme - Class in uk.ac.starlink.auth
Implements an authentication scheme that requires a cookie (or possibly cookies) for authentication, and in which the source of the cookie is given in the challenge.
getAuthenticatedId() - Method in class uk.ac.starlink.auth.AuthStatus
Returns the authenticated user ID for this connection.
getAuthenticatedId(AuthConnection) - Static method in class uk.ac.starlink.auth.AuthUtil
Returns the authenticated user ID recorded in the headers of a URL connection.
getAuthType() - Method in class uk.ac.starlink.auth.AuthStatus
Returns the authentication type for this connection.
getChallenges(URLConnection) - Static method in class uk.ac.starlink.auth.AuthUtil
Extracts challenges from an HTTP response.
getConnection() - Method in class uk.ac.starlink.auth.AuthConnection
Returns this object's URLConnection.
getContext() - Method in class uk.ac.starlink.auth.AuthConnection
Returns this objects AuthContext, as used to make the connection.
getContextFactory(Challenge, URL) - Static method in class uk.ac.starlink.auth.AuthTest
 
getCurlArgs(URL, boolean) - Method in interface uk.ac.starlink.auth.AuthContext
Returns an array of command-line arguments that could be passed to curl(1) corresponding to the authentication arrangements implemented by this context.
getIdentityString() - Method in class uk.ac.starlink.auth.AuthStatus
Returns a non-null string that can be used to characterise the user identity.
getInstance() - Static method in class uk.ac.starlink.auth.AuthManager
Returns the default instance of this class.
getName() - Method in interface uk.ac.starlink.auth.AuthScheme
Returns a human-readable name identifying the authentication scheme implemented by this object.
getName() - Method in class uk.ac.starlink.auth.BasicAuthScheme
 
getName() - Method in class uk.ac.starlink.auth.CadcAuthScheme
 
getName() - Method in class uk.ac.starlink.auth.GacsCookieAuthScheme
 
getName() - Method in class uk.ac.starlink.auth.GenericCookieAuthScheme
 
getName() - Method in class uk.ac.starlink.auth.IvoaAuthScheme
 
getParams() - Method in class uk.ac.starlink.auth.Challenge
Returns any auth parameters that form part of this challenge excluding the realm.
getParent() - Method in class uk.ac.starlink.auth.UserInterface
Returns the GUI component to which this UI is subordinate.
getPassword() - Method in class uk.ac.starlink.auth.UserPass
Returns the password.
getPropertiesUi() - Static method in class uk.ac.starlink.auth.UserInterface
Returns a headless UI that takes username and password from the system properties UserInterface.USERNAME_PROP and UserInterface.PASSWORD_PROP respectively.
getPropertiesUi(String, String) - Static method in class uk.ac.starlink.auth.UserInterface
Returns a headless UI that takes username and password from two named System Properties.
getProtocol(String) - Static method in class uk.ac.starlink.auth.IvoaLoginProtocol
Returns an instance for a given standard ID.
getProtocolName() - Method in class uk.ac.starlink.auth.IvoaLoginProtocol
 
getProtocolName() - Method in interface uk.ac.starlink.auth.LoginProtocol
Returns a name identifying this protocol.
getRealm() - Method in class uk.ac.starlink.auth.Challenge
Returns the authentication realm if defined.
getRedirectUrl(URLConnection) - Method in class uk.ac.starlink.auth.Redirector
Returns a URL to which connections should be redirected from a supplied URL connection, according to this redirector's policy.
getRequiredParameter(String) - Method in class uk.ac.starlink.auth.Challenge
Utility method giving a non-empty value for a named parameter of this challenge.
getRequiredParameterUrl(String) - Method in class uk.ac.starlink.auth.Challenge
Utility method giving a non-null URL value for a named parameter of this challenge.
getRequiredRealm() - Method in class uk.ac.starlink.auth.Challenge
Utility method giving a non-empty realm for this challenge.
getResponseCode(URLConnection) - Static method in class uk.ac.starlink.auth.AuthUtil
Returns the HTTP response code from a URL connection.
getScheme() - Method in interface uk.ac.starlink.auth.AuthContext
Returns the scheme that yielded this context.
getSchemeByName(String) - Static method in class uk.ac.starlink.auth.AuthTest
 
getSchemeName() - Method in class uk.ac.starlink.auth.Challenge
Returns the authentication scheme name.
getSchemes() - Method in class uk.ac.starlink.auth.AuthManager
Returns a mutable list of authentication schemes known by this manager.
getStandardId() - Method in class uk.ac.starlink.auth.IvoaLoginProtocol
Returns the URI identifying this login method.
getSubtype() - Method in class uk.ac.starlink.auth.ContentType
Returns the Subtype part of this content type.
getSuccessResponse(LoginProtocol, URL, UserInterface) - Static method in class uk.ac.starlink.auth.IvoaAuthScheme
Utility method that attempts to acquire a successful HTTP response from a login URL given a login protocol, with credential input from the user.
getToken68() - Method in class uk.ac.starlink.auth.Challenge
Returns the token68 value if defined.
getType() - Method in class uk.ac.starlink.auth.ContentType
Returns the Type part of this content type.
getUserInterface() - Method in class uk.ac.starlink.auth.AuthManager
Returns the object that controls how the user is queried for credentials.
getUsername() - Method in class uk.ac.starlink.auth.UserPass
Returns the username.
GUI - Static variable in class uk.ac.starlink.auth.UserInterface
Instance that uses Swing popup dialogues.

H

hasCredentials() - Method in interface uk.ac.starlink.auth.AuthContext
Indicates whether this context is actually believed capable of authenticating.
hashCode() - Method in class uk.ac.starlink.auth.Challenge
 
hashCode() - Method in class uk.ac.starlink.auth.ContentType
 
hashCode() - Method in class uk.ac.starlink.auth.ProtectionSpace
 
hashCode() - Method in class uk.ac.starlink.auth.UserPass
 

I

INSTANCE - Static variable in class uk.ac.starlink.auth.BasicAuthScheme
Sole instance.
INSTANCE - Static variable in class uk.ac.starlink.auth.BearerIvoaAuthScheme
Singleton instance.
INSTANCE - Static variable in class uk.ac.starlink.auth.CadcAuthScheme
Singleton instance.
INSTANCE - Static variable in class uk.ac.starlink.auth.CookieIvoaAuthScheme
Singleton instance.
INSTANCE - Static variable in class uk.ac.starlink.auth.GacsCookieAuthScheme
 
INSTANCE - Static variable in class uk.ac.starlink.auth.GenericCookieAuthScheme
Singleton instance.
isAuthenticated() - Method in class uk.ac.starlink.auth.AuthStatus
Indicates whether authentication has been established.
isChallengeDomain(Challenge, URL) - Method in interface uk.ac.starlink.auth.AuthContext
Indicates whether this context is expected to be good for authenticating against a given challenge.
isExpired() - Method in interface uk.ac.starlink.auth.AuthContext
Indicates whether this authentication period's validity is known to have expired.
isRedirect(int) - Method in class uk.ac.starlink.auth.Redirector
Indicates whether a given HTTP response code should be followed as a redirect.
isUrlDomain(URL) - Method in interface uk.ac.starlink.auth.AuthContext
Indicates whether this context is expected to be good for authenticating a given URL.
IvoaAuthScheme - Class in uk.ac.starlink.auth
Partial AuthScheme implementation for standard SSO challenges.
IvoaAuthScheme(String) - Constructor for class uk.ac.starlink.auth.IvoaAuthScheme
Constructor.
IvoaAuthScheme.AuthReader<T> - Interface in uk.ac.starlink.auth
Knows how to acquire specific authentication information from an open URL connection.
IvoaLoginProtocol - Class in uk.ac.starlink.auth
Provides SSO-compliant implementations of LoginProtocol.

L

LOG_SECRETS - Static variable in class uk.ac.starlink.auth.AuthUtil
Global config: if true, passwords etc may be logged by logger.
LoginProtocol - Interface in uk.ac.starlink.auth
Defines a way to present credentials for the purpose of subsequent access to a service.
LOGSECRETS_PROP - Static variable in class uk.ac.starlink.auth.AuthUtil
Name of system property "auth.logsecrets" which if set "true" will allow reporting of sensitive information such as passwords through the logging system.

M

main(String[]) - Static method in class uk.ac.starlink.auth.AuthTest
 
main(String[]) - Static method in class uk.ac.starlink.auth.Challenge
Will parse a WWW-Authenticate string on the command line and print out the parsed challenges.
makeConnection(URL, UrlConnector, Redirector) - Method in class uk.ac.starlink.auth.AuthManager
Opens a URL connection to a given URL with specified configuration, negotiating authentication and with configurable handling of 3xx redirection.
matches(String, String) - Method in class uk.ac.starlink.auth.ContentType
Indicates whether the type and subtype match a given pair.
message(String) - Method in class uk.ac.starlink.auth.UserInterface
Sends a message to the user.

N

NO_AUTH - Static variable in class uk.ac.starlink.auth.AuthStatus
Connection with no possible or actual authentication.
NO_AUTH - Static variable in class uk.ac.starlink.auth.UserInterface
Instance that will not authenticate.
NO_REDIRECT - Static variable in class uk.ac.starlink.auth.Redirector
No redirections are performed.

O

openStream(URL) - Method in class uk.ac.starlink.auth.AuthManager
Returns the content stream acquired by opening a URL.

P

parse(String) - Static method in class uk.ac.starlink.auth.ContentType
Parses a Content-Type (MIME type) string.
parseChallenges(String) - Static method in class uk.ac.starlink.auth.Challenge
Parses the content of a WWW-Authenticate header as a sequence of RFC7235 challenges.
PASSWORD - Static variable in class uk.ac.starlink.auth.GenericCookieAuthScheme
Key for POSTing password to login URL.
PASSWORD_PROP - Static variable in class uk.ac.starlink.auth.UserInterface
Name of password system property for headless UI instance.
popUiParent() - Static method in class uk.ac.starlink.auth.AuthUtil
Restores the parent component of the user interface to its old value.
postForm(URL, Map<String, String>) - Static method in class uk.ac.starlink.auth.AuthUtil
Posts name=value pairs over HTTP in application/x-www-form-urlencoded format.
postForm(HttpURLConnection, Map<String, String>) - Static method in class uk.ac.starlink.auth.AuthUtil
Posts name=value pairs to an HTTP connection in application/x-www-form-urlencoded format.
presentCredentials(URL, UserPass) - Method in interface uk.ac.starlink.auth.LoginProtocol
Makes a single attempt at acquiring a response from a login interface.
ProtectionSpace - Class in uk.ac.starlink.auth
Protection Space is a concept defined in RFC7235, aggregating the canonical root URI and an optional realm.
ProtectionSpace(String, String, String) - Constructor for class uk.ac.starlink.auth.ProtectionSpace
Constructs a ProtectionSpace using URL parts.
ProtectionSpace(URL, String) - Constructor for class uk.ac.starlink.auth.ProtectionSpace
Constructs a ProtectionSpace using a URL.
pushUiParent(Component) - Static method in class uk.ac.starlink.auth.AuthUtil
Replaces the parent component of the user interface currently installed on the default AuthManager instance.

R

readAuth(HttpURLConnection) - Method in interface uk.ac.starlink.auth.IvoaAuthScheme.AuthReader
Reads an item of information from an open URL connection.
readAuth(LoginProtocol, URL, UserInterface, IvoaAuthScheme.AuthReader<A>) - Static method in class uk.ac.starlink.auth.IvoaAuthScheme
Utility method that acquires authentication information from a login URL given a login protocol, with credential input from the user.
readUserPassword(String) - Method in class uk.ac.starlink.auth.UserInterface
Returns a username/password pair, or null if the user declines to supply one.
Redirector - Class in uk.ac.starlink.auth
Defines how HTTP 3xx redirects are handled.
Redirector() - Constructor for class uk.ac.starlink.auth.Redirector
 

S

SCHEME_NAME - Static variable in class uk.ac.starlink.auth.BearerIvoaAuthScheme
Name and identifier for this scheme.
SCHEME_NAME - Static variable in class uk.ac.starlink.auth.CookieIvoaAuthScheme
Name and identifier for this scheme.
SCHEMES - Static variable in class uk.ac.starlink.auth.AuthTest
 
setDefaultInstance(AuthManager) - Static method in class uk.ac.starlink.auth.AuthManager
Resets the default AuthManager instance.
setParent(Component) - Method in class uk.ac.starlink.auth.UserInterface
Sets a GUI component to which this UI is subordinate.
setUserInterface(UserInterface) - Method in class uk.ac.starlink.auth.AuthManager
Sets the object that controls how the user is queried for credentials.
SSO_URL - Static variable in class uk.ac.starlink.auth.IvoaLoginProtocol
 
STANDARDID_PARAM - Static variable in class uk.ac.starlink.auth.IvoaAuthScheme
 

T

TLS_WITH_PASSWORD - Static variable in class uk.ac.starlink.auth.IvoaLoginProtocol
Implementation for standard_id="ivo://ivoa.net/sso#tls-with-password".
TOKEN_HEADER - Static variable in class uk.ac.starlink.auth.BearerIvoaAuthScheme
Name of login response header containing bearer token.
toString() - Method in class uk.ac.starlink.auth.AuthStatus
 
toString() - Method in class uk.ac.starlink.auth.Challenge
 
toString() - Method in class uk.ac.starlink.auth.ContentType
 
toString() - Method in class uk.ac.starlink.auth.ProtectionSpace
 

U

uk.ac.starlink.auth - package uk.ac.starlink.auth
 
unNullString(String) - Static method in class uk.ac.starlink.auth.AuthUtil
Returns the input string, unless it's null, in which case it returns the empty string.
UrlConnector - Interface in uk.ac.starlink.auth
Defines how a connection is obtained from a URL.
useGacsCapabilitiesHacks(URL) - Static method in class uk.ac.starlink.auth.AuthUtil
Whether to hack around deficiencies known to exist in GACS /capabilities endpoint for a given URL.
useGacsDataHacks(URL) - Static method in class uk.ac.starlink.auth.AuthUtil
Whether to hack around deficiencies known to exist in GACS DataLink service resources for a given URL.
UserInterface - Class in uk.ac.starlink.auth
Abstraction via which authentication classes can acquire credentials from the user.
UserInterface() - Constructor for class uk.ac.starlink.auth.UserInterface
 
USERNAME - Static variable in class uk.ac.starlink.auth.GenericCookieAuthScheme
Key for POSTing username to login URL.
USERNAME_PROP - Static variable in class uk.ac.starlink.auth.UserInterface
Name of username system property for headless UI instance.
UserPass - Class in uk.ac.starlink.auth
Aggregates a username and password.
UserPass(String, char[]) - Constructor for class uk.ac.starlink.auth.UserPass
Constructor.
UTF8 - Static variable in class uk.ac.starlink.auth.AuthUtil
UTF-8 charset, guaranteed present.

V

valueOf(String) - Static method in enum uk.ac.starlink.auth.AuthType
Returns the enum constant of this type with the specified name.
values() - Static method in enum uk.ac.starlink.auth.AuthType
Returns an array containing the constants of this enum type, in the order they are declared.

W

willRedirect(String, String) - Method in class uk.ac.starlink.auth.Redirector
Indicates whether HTTP 3xx redirection is permitted between two URL protocols.
A B C D E F G H I L M N O P R S T U V W 
Skip navigation links