de.enflexit.oidc

Class OIDCAuthorization

java.lang.Object

de.enflexit.oidc.OIDCAuthorization

public class OIDCAuthorization
extends java.lang.Object

This class provides a simple interface to the OpenID Connect authorisation. Use with getInstance(), getDialog()/connect() and getUserID().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OIDCAuthorization.URLProcessor The Class URLProcessor.

Method Summary

Modifier and Type	Method and Description
boolean	accessResource() Access some resource previously set by setResourceURI(String).
boolean	accessResource(java.lang.String url, java.lang.String presetUsername, java.awt.Window owner) Access some resource like accessResource(), but also provide the URL and presetUsername/owner for the dialog.
boolean	accessResource(java.lang.String presetUsername, java.awt.Window owner) Access some resource like accessResource(), but also provide the presetUsername/owner for the dialog.
boolean	authorizeByUserAndPW(java.lang.String username, java.lang.String password) Connect to the authorization server and get a valid token.
java.lang.String	getClientID() Gets the client id.
java.lang.String	getClientSecret() Gets the client secret.
javax.swing.JDialog	getDialog() Gets the authorization dialog (with null defaults).
javax.swing.JDialog	getDialog(java.lang.String presetUsername, java.awt.Window owner) Gets the authorization dialog.
static OIDCAuthorization	getInstance() Gets the single instance of OIDCAuthorization.
java.lang.String	getIssuerURI() Gets the issuer URI.
java.lang.String	getLastSuccessfulUser() Returns the last successful user name.
SimpleOIDCClient	getOIDCClient() Gets the OIDC client.
java.lang.String	getResourceURI() Gets the resource URI.
OIDCAuthorization.URLProcessor	getUrlProcessor() Gets the url processor.
java.lang.String	getUserID() Gets the unique ID of the user authenticated.
void	init() Initiates the authorization process by setting the necessary URIs and data to the OIDC client and preparing the URLProcessor.
boolean	isValid() Checks if OIDC token is valid, so access has been granted.
OIDCAuthorization	setAvailabilityHandler(OIDCResourceAvailabilityHandler availabilityHandler) Sets the availability handler.
void	setIssuerURI(java.lang.String issuerURI) Sets the issuer URI.
void	setResourceURI(java.lang.String resourceURI) Sets the resource URI.
void	setTranslator(Translator translator) Sets the translator.
void	setTrustStore(java.io.File trustStoreFile) Sets the trust store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static OIDCAuthorization getInstance()

Gets the single instance of OIDCAuthorization.

Returns:

single instance of OIDCAuthorization

getOIDCClient

public SimpleOIDCClient getOIDCClient()
                               throws java.net.URISyntaxException

Gets the OIDC client.

Returns:

the OIDC client

Throws:

java.net.URISyntaxException - the URI syntax exception

getUrlProcessor

public OIDCAuthorization.URLProcessor getUrlProcessor()
                                               throws java.net.URISyntaxException,
                                                      java.io.IOException,
                                                      java.security.KeyManagementException,
                                                      java.security.NoSuchAlgorithmException,
                                                      java.security.cert.CertificateException,
                                                      java.security.KeyStoreException

Gets the url processor.

Returns:

the url processor

Throws:

java.net.URISyntaxException - the URI syntax exception

java.io.IOException - Signals that an I/O exception has occurred.

java.security.KeyManagementException - the key management exception

java.security.NoSuchAlgorithmException - the no such algorithm exception

java.security.cert.CertificateException - the certificate exception

java.security.KeyStoreException - the key store exception

setTrustStore

public void setTrustStore(java.io.File trustStoreFile)
                   throws java.net.URISyntaxException

Sets the trust store.

Parameters:

trustStoreFile - the new trust store

Throws:

java.net.URISyntaxException - the URI syntax exception

setAvailabilityHandler

public OIDCAuthorization setAvailabilityHandler(OIDCResourceAvailabilityHandler availabilityHandler)

Sets the availability handler.

Parameters:

availabilityHandler - the availability handler

Returns:

the OIDC authorization

getIssuerURI

public java.lang.String getIssuerURI()

Gets the issuer URI.

Returns:

the issuer URI

setIssuerURI

public void setIssuerURI(java.lang.String issuerURI)

Sets the issuer URI.

Parameters:

issuerURI - the new issuer URI

getResourceURI

public java.lang.String getResourceURI()

Gets the resource URI.

Returns:

the resource URI

setResourceURI

public void setResourceURI(java.lang.String resourceURI)

Sets the resource URI.

Parameters:

resourceURI - the new resource URI

getClientID

public java.lang.String getClientID()

Gets the client id.

Returns:

the client id

getClientSecret

public java.lang.String getClientSecret()

Gets the client secret.

Returns:

the client secret

getDialog

public javax.swing.JDialog getDialog()

Gets the authorization dialog (with null defaults).

Returns:

the dialog

getDialog

public javax.swing.JDialog getDialog(java.lang.String presetUsername,
                                     java.awt.Window owner)

Gets the authorization dialog.

Parameters:

presetUsername - username which should be shown preset when displaying the dialog

owner - the window to which the dialog should belong (to center etc.)

Returns:

the dialog

isValid

public boolean isValid()
                throws java.net.URISyntaxException

Checks if OIDC token is valid, so access has been granted.

Returns:

true, if is valid

Throws:

java.net.URISyntaxException - the URI syntax exception

getUserID

public java.lang.String getUserID()
                           throws de.enflexit.oidc.OIDCAuthorization.OIDCProblemException,
                                  java.net.URISyntaxException

Gets the unique ID of the user authenticated.

Returns:

the user ID

Throws:

OIDCProblemException - if the token is not valid/the user is not authenticated yet

java.net.URISyntaxException - the URI syntax exception

de.enflexit.oidc.OIDCAuthorization.OIDCProblemException

init

public void init()
          throws java.net.URISyntaxException,
                 java.io.IOException,
                 java.security.KeyManagementException,
                 java.security.NoSuchAlgorithmException,
                 java.security.cert.CertificateException,
                 java.security.KeyStoreException

Initiates the authorization process by setting the necessary URIs and data to the OIDC client and preparing the URLProcessor.

Throws:

java.net.URISyntaxException - the URI syntax exception

java.io.IOException - Signals that an I/O exception has occurred.

java.security.KeyManagementException - the key management exception

java.security.NoSuchAlgorithmException - the no such algorithm exception

java.security.cert.CertificateException - the certificate exception

java.security.KeyStoreException - the key store exception

authorizeByUserAndPW

public boolean authorizeByUserAndPW(java.lang.String username,
                                    java.lang.String password)
                             throws java.net.URISyntaxException,
                                    java.io.IOException,
                                    java.security.KeyManagementException,
                                    java.security.NoSuchAlgorithmException,
                                    java.security.cert.CertificateException,
                                    java.security.KeyStoreException

Connect to the authorization server and get a valid token.

Parameters:

username - the username

password - the password

Returns:

true, if successful

Throws:

java.net.URISyntaxException - the URI syntax exception

java.io.IOException - Signals that an I/O exception has occurred.

java.security.KeyManagementException - the key management exception

java.security.NoSuchAlgorithmException - the no such algorithm exception

java.security.cert.CertificateException - the certificate exception

java.security.KeyStoreException - the key store exception

accessResource

public boolean accessResource()
                       throws java.io.IOException,
                              java.net.URISyntaxException,
                              java.security.KeyManagementException,
                              java.security.NoSuchAlgorithmException,
                              java.security.cert.CertificateException,
                              java.security.KeyStoreException

Access some resource previously set by setResourceURI(String). If not accessible, show user/password dialog

Returns:

true, if successful

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

java.net.URISyntaxException - the URI syntax exception

java.security.KeyManagementException - the key management exception

java.security.NoSuchAlgorithmException - the no such algorithm exception

java.security.cert.CertificateException - the certificate exception

java.security.KeyStoreException - the key store exception

accessResource

public boolean accessResource(java.lang.String presetUsername,
                              java.awt.Window owner)
                       throws java.io.IOException,
                              java.net.URISyntaxException,
                              java.security.KeyManagementException,
                              java.security.NoSuchAlgorithmException,
                              java.security.cert.CertificateException,
                              java.security.KeyStoreException

Access some resource like accessResource(), but also provide the presetUsername/owner for the dialog.

Parameters:

presetUsername - the preset username

owner - the owner frame

Returns:

true, if successful

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

java.net.URISyntaxException - the URI syntax exception

java.security.KeyManagementException - the key management exception

java.security.NoSuchAlgorithmException - the no such algorithm exception

java.security.cert.CertificateException - the certificate exception

java.security.KeyStoreException - the key store exception

accessResource

public boolean accessResource(java.lang.String url,
                              java.lang.String presetUsername,
                              java.awt.Window owner)
                       throws java.io.IOException,
                              java.net.URISyntaxException,
                              java.security.KeyManagementException,
                              java.security.NoSuchAlgorithmException,
                              java.security.cert.CertificateException,
                              java.security.KeyStoreException

Access some resource like accessResource(), but also provide the URL and presetUsername/owner for the dialog.

Parameters:

url - the url

presetUsername - the preset username

owner - the owner frame

Returns:

true, if successful

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

java.net.URISyntaxException - the URI syntax exception

java.security.KeyManagementException - the key management exception

java.security.NoSuchAlgorithmException - the no such algorithm exception

java.security.cert.CertificateException - the certificate exception

java.security.KeyStoreException - the key store exception

setTranslator

public void setTranslator(Translator translator)

Sets the translator.

Parameters:

translator - the new translator

getLastSuccessfulUser

public java.lang.String getLastSuccessfulUser()

Returns the last successful user name.

Returns:

the last successful user