Package org.oa4mp.server.api.storage.servlet

Class AuthorizationServletConfig

java.lang.Object

org.oa4mp.server.api.storage.servlet.AuthorizationServletConfig

All Implemented Interfaces:

edu.uiuc.ncsa.security.core.configuration.ConfigurationTags, edu.uiuc.ncsa.security.core.configuration.StorageConfigurationTags, edu.uiuc.ncsa.security.util.mail.MailConfigurationTags, OA4MPConfigTags

public class AuthorizationServletConfig
extends Object
implements OA4MPConfigTags

Created by Jeff Gaynor
on 12/4/12 at 11:28 AM

Field Summary

Fields inherited from interface edu.uiuc.ncsa.security.core.configuration.ConfigurationTags

DEBUG

Fields inherited from interface edu.uiuc.ncsa.security.util.mail.MailConfigurationTags

MAIL, MAIL_COMPONENT, MAIL_CONFIG_ADMIN, MAIL_CONFIG_ALERTS, MAIL_CONFIG_DEFAULT_NAME, MAIL_CONFIG_HELP, MAIL_CONFIG_ROOT, MAIL_ENABLED, MAIL_FAIL_ON_MISSING_CONFIG, MAIL_MESSAGE_TEMPLATE, MAIL_NAME, MAIL_PARENT, MAIL_PASSWORD, MAIL_PORT, MAIL_RECIPIENTS, MAIL_SERVER, MAIL_START_TLS, MAIL_SUBJECT_TEMPLATE, MAIL_USE_SSL, MAIL_USERNAME

Fields inherited from interface org.oa4mp.server.api.OA4MPConfigTags

ADMIN_CLIENT_STORE, ARCHIVED_USERS, AUTHORIZATION_SERVLET, AUTHORIZATION_SERVLET_HEADER_FIELD_NAME, AUTHORIZATION_SERVLET_HEADER_REQUIRE, AUTHORIZATION_SERVLET_HEADER_USE, AUTHORIZATION_SERVLET_PROXY_CONFIG_FILE, AUTHORIZATION_SERVLET_PROXY_CONFIG_NAME, AUTHORIZATION_SERVLET_PROXY_DF_LOCAL_CONSENT_REQUIRED, AUTHORIZATION_SERVLET_RETURN_DN_AS_USERNAME, AUTHORIZATION_SERVLET_SHOW_LOGON, AUTHORIZATION_SERVLET_URI, AUTHORIZATION_SERVLET_USE_MODE, AUTHORIZATION_SERVLET_USE_MODE_DEDICATED_ISSUER, AUTHORIZATION_SERVLET_USE_MODE_EXTERNAL_SERVICE, AUTHORIZATION_SERVLET_USE_MODE_HEADER, AUTHORIZATION_SERVLET_USE_MODE_NATIVE, AUTHORIZATION_SERVLET_USE_MODE_PROXY, AUTHORIZATION_SERVLET_USE_PROXY, AUTHORIZATION_SERVLET_VERIFY_USERNAME, CLIENT_APPROVAL_STORE, CLIENTS_STORE, COMPONENT, CONVERT_DN_TO_GLOBUS_ID, DEVICE_FLOW_AUTHORIZATION_URI, DEVICE_FLOW_CODE_CHARS, DEVICE_FLOW_CODE_PERIOD_LENGTH, DEVICE_FLOW_CODE_SEPARATOR, DEVICE_FLOW_INTERVAL, DEVICE_FLOW_LIFETIME, DEVICE_FLOW_SERVLET, DEVICE_FLOW_SERVLET_URI, DEVICE_FLOW_USER_CODE_LENGTH, DISABLE_DEFAULT_STORES, ENABLE_CCF_SUPPORT, ENABLE_RFC8628_SUPPORT, ENABLE_RFC8693_SUPPORT, ENABLE_UTIL_SERVLET, ID_SCHEME, ID_SPP, IDENTITY_PROVIDERS, MAX_ALLOWED_NEW_CLIENT_REQUESTS, MESSAGES, MYPROXY, MYPROXY_HOST, MYPROXY_LOA, MYPROXY_LOA_NAME, MYPROXY_LOA_PORT, MYPROXY_PORT, MYPROXY_SERVER_DN, MYPROXY_SOCKET_TIMEOUT, MYPROXY_USE_PROXY, PERMISSION_STORE, PINGABLE, SEQUENCE, SERIAL_STRING_NS, SERIAL_STRING_PREFIX, SERIAL_STRING_TOKEN, SERIAL_STRINGS, SERVICE_ADDRESS, TOKEN_EXCHANGE_RECORD_STORE, TOKEN_PREFIX, TRANSACTIONS_STORE, TWO_FACTOR, USERS, VIRTUAL_ORGANIZATION_STORE

Fields inherited from interface edu.uiuc.ncsa.security.core.configuration.StorageConfigurationTags

AGGREGATE_STORE, DERBY_STORE, DERBY_STORE_TYPE_FILE, DERBY_STORE_TYPE_MEMORY, DERBY_STORE_TYPE_SERVER, FILE_STORE, FS_DATA, FS_INDEX, FS_PATH, FS_REMOVE_EMPTY_FILES, FS_REMOVE_FAILED_FILES, MARIADB_STORE, MEMORY_STORE, MYSQL_STORE, POSTGRESQL_STORE, SQL_DATABASE, SQL_PREFIX, SQL_SCHEMA, SQL_TABLENAME

Constructor Summary

Constructors

Constructor	Description
AuthorizationServletConfig()
AuthorizationServletConfig(String authorizationURI, boolean requireHeader, String headerFieldName, boolean returnDnAsUsername, boolean showLogon, boolean verifyUsername, boolean convertDNToGlobusID)
AuthorizationServletConfig(String useMode, String authorizationURI)
AuthorizationServletConfig(String cfgFile, String cfgName, boolean localDFConsent)	Constructor if a proxy is to be used for authorization.

Method Summary

Modifier and Type	Method	Description
String	getAuthorizationURI()
String	getCfgFile()
String	getCfgName()
String	getHeaderFieldName()
String	getUseMode()
boolean	isConvertDNToGlobusID()
boolean	isLocalDFConsent()	This is used only if proxy mode is set true.
boolean	isRequireHeader()
boolean	isReturnDnAsUsername()
boolean	isShowLogon()
boolean	isVerifyUsername()
void	setAuthorizationURI(String authorizationURI)
void	setCfgFile(String cfgFile)
void	setCfgName(String cfgName)
void	setConvertDNToGlobusID(boolean convertDNToGlobusID)
void	setLocalDFConsent(boolean localDFConsent)
void	setShowLogon(boolean showLogon)
void	setUseMode(String useMode)
void	setVerifyUsername(boolean verifyUsername)
String	toString()
boolean	useExternalAuthorization()	Is authorization done with an external source, i.e., not OA4MP?

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationServletConfig

public AuthorizationServletConfig()

AuthorizationServletConfig

public AuthorizationServletConfig(String useMode,
                                  String authorizationURI)

AuthorizationServletConfig

public AuthorizationServletConfig(String cfgFile,
                                  String cfgName,
                                  boolean localDFConsent)

Constructor if a proxy is to be used for authorization. This points to a file with the configuration in it and the name of the configuration to use.

Parameters:

cfgFile -

cfgName -

AuthorizationServletConfig

public AuthorizationServletConfig(String authorizationURI,
                                  boolean requireHeader,
                                  String headerFieldName,
                                  boolean returnDnAsUsername,
                                  boolean showLogon,
                                  boolean verifyUsername,
                                  boolean convertDNToGlobusID)

Method Detail

getUseMode

public String getUseMode()

setUseMode

public void setUseMode(String useMode)

useExternalAuthorization

public boolean useExternalAuthorization()

Is authorization done with an external source, i.e., not OA4MP?

Returns:

isLocalDFConsent

public boolean isLocalDFConsent()

This is used only if proxy mode is set true. It tells the local system to sent OA4MP specific request parameters along with the proxy request to have the proxying client forward the user to a consent screen rather than ending the interaction.

Returns:

setLocalDFConsent

public void setLocalDFConsent(boolean localDFConsent)

getCfgFile

public String getCfgFile()

setCfgFile

public void setCfgFile(String cfgFile)

getCfgName

public String getCfgName()

setCfgName

public void setCfgName(String cfgName)

isVerifyUsername

public boolean isVerifyUsername()

setVerifyUsername

public void setVerifyUsername(boolean verifyUsername)

isShowLogon

public boolean isShowLogon()

setShowLogon

public void setShowLogon(boolean showLogon)

getAuthorizationURI

public String getAuthorizationURI()

setAuthorizationURI

public void setAuthorizationURI(String authorizationURI)

isConvertDNToGlobusID

public boolean isConvertDNToGlobusID()

setConvertDNToGlobusID

public void setConvertDNToGlobusID(boolean convertDNToGlobusID)

isReturnDnAsUsername

public boolean isReturnDnAsUsername()

getHeaderFieldName

public String getHeaderFieldName()

isRequireHeader

public boolean isRequireHeader()

toString

public String toString()

Overrides:

toString in class Object