fedora.server.security
Class BESecurityConfig

java.lang.Object
  fedora.server.security.BESecurityConfig

public class BESecurityConfig
extends java.lang.Object

Security configuration for backend services.

Author:

cwilper@cs.cornell.edu

Constructor Summary

BESecurityConfig()
Create an empty BESecurityConfig with an empty map of BMechRoleConfigs and null values for everything else.

Method Summary

void	addEmptyConfigs(java.util.Map pidToMethodList) Add empty bMech and method configurations given by the map if they are not already already defined.
static BESecurityConfig	fromStream(java.io.InputStream in) Instantiate a BESecurityConfig from an XML stream.
java.util.SortedMap<java.lang.String,BMechRoleConfig>	getBMechConfigs() Get the mutable, sorted, PID-keyed map of BMechRoleConfigs.
DefaultRoleConfig	getDefaultConfig() Get the default role configuration.
java.lang.Boolean	getEffectiveInternalBasicAuth() Get whether basic auth is effectively used for Fedora-to-self calls.
java.lang.String[]	getEffectiveInternalIPList() Get the effective list of internal IP addresses.
java.lang.String	getEffectiveInternalPassword() Get the effective internal password for basic auth Fedora-to-self calls.
java.lang.Boolean	getEffectiveInternalSSL() Get whether SSL is effectively used for Fedora-to-self calls.
java.lang.String	getEffectiveInternalUsername() Get the effective internal username for basic auth Fedora-to-self calls.
java.lang.Boolean	getInternalBasicAuth() Get whether basic auth should be used for Fedora-to-self calls.
java.lang.String[]	getInternalIPList() Get the list of internal IP addresses.
java.lang.String	getInternalPassword() Get the internal password.
java.lang.Boolean	getInternalSSL() Get whether SSL should be used for Fedora-to-self calls.
java.lang.String	getInternalUsername() Get the internal username.
void	setDefaultConfig(DefaultRoleConfig config) Set the default role configuration.
void	setInternalBasicAuth(java.lang.Boolean value) Set whether basic auth is used for Fedora-to-self calls.
void	setInternalIPList(java.lang.String[] ips) Set the list of internal IP addresses.
void	setInternalPassword(java.lang.String password) Set the internal password.
void	setInternalSSL(java.lang.Boolean value) Set whether SSL is used for Fedora-to-self calls.
void	setInternalUsername(java.lang.String username) Set the internal username.
void	toStream(boolean skipNonOverrides, java.io.OutputStream out) Serialize to the given stream, closing it when finished.
void	write(boolean skipNonOverrides, boolean withXMLDeclaration, java.io.PrintWriter writer) Serialize to the given writer, keeping it open when finished.

Methods inherited from class java.lang.Object

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

Constructor Detail

BESecurityConfig

public BESecurityConfig()

Create an empty BESecurityConfig with an empty map of BMechRoleConfigs and null values for everything else.

Method Detail

getDefaultConfig

public DefaultRoleConfig getDefaultConfig()

Get the default role configuration.

setDefaultConfig

public void setDefaultConfig(DefaultRoleConfig config)

Set the default role configuration.

getInternalSSL

public java.lang.Boolean getInternalSSL()

Get whether SSL should be used for Fedora-to-self calls. This should be true if API-A is only available via SSL.

getEffectiveInternalSSL

public java.lang.Boolean getEffectiveInternalSSL()

Get whether SSL is effectively used for Fedora-to-self calls. This will be the internalSSL value, if set, or the inherited call value from the default role, if set, or Boolean.FALSE.

setInternalSSL

public void setInternalSSL(java.lang.Boolean value)

Set whether SSL is used for Fedora-to-self calls.

getInternalBasicAuth

public java.lang.Boolean getInternalBasicAuth()

Get whether basic auth should be used for Fedora-to-self calls. This should be true if API-A requires basic auth.

getEffectiveInternalBasicAuth

public java.lang.Boolean getEffectiveInternalBasicAuth()

Get whether basic auth is effectively used for Fedora-to-self calls. This will be the internalBasicAuth value, if set, or the inherited call value from the default role, if set, or Boolean.FALSE.

setInternalBasicAuth

public void setInternalBasicAuth(java.lang.Boolean value)

Set whether basic auth is used for Fedora-to-self calls.

getInternalUsername

public java.lang.String getInternalUsername()

Get the internal username.

getEffectiveInternalUsername

public java.lang.String getEffectiveInternalUsername()

Get the effective internal username for basic auth Fedora-to-self calls. This will be the internal username, if set, or the inherited call value from the default role, if set, or null.

setInternalUsername

public void setInternalUsername(java.lang.String username)

Set the internal username.

getInternalPassword

public java.lang.String getInternalPassword()

Get the internal password.

getEffectiveInternalPassword

public java.lang.String getEffectiveInternalPassword()

Get the effective internal password for basic auth Fedora-to-self calls. This will be the internal password, if set, or the inherited call value from the default role, if set, or null.

setInternalPassword

public void setInternalPassword(java.lang.String password)

Set the internal password.

getInternalIPList

public java.lang.String[] getInternalIPList()

Get the list of internal IP addresses.

getEffectiveInternalIPList

public java.lang.String[] getEffectiveInternalIPList()

Get the effective list of internal IP addresses. This will be the internalIPList value, if set, or the inherited value from the default role, if set, or null.

setInternalIPList

public void setInternalIPList(java.lang.String[] ips)

Set the list of internal IP addresses.

getBMechConfigs

public java.util.SortedMap<java.lang.String,BMechRoleConfig> getBMechConfigs()

Get the mutable, sorted, PID-keyed map of BMechRoleConfigs.

addEmptyConfigs

public void addEmptyConfigs(java.util.Map pidToMethodList)

Add empty bMech and method configurations given by the map if they are not already already defined.

fromStream

public static BESecurityConfig fromStream(java.io.InputStream in)
                                   throws java.lang.Exception

Instantiate a BESecurityConfig from an XML stream.

Throws:

java.lang.Exception

toStream

public void toStream(boolean skipNonOverrides,
                     java.io.OutputStream out)
              throws java.lang.Exception

Serialize to the given stream, closing it when finished. If skipNonOverrides is true, any configuration whose values are all null will not be written.

Throws:

java.lang.Exception

write

public void write(boolean skipNonOverrides,
                  boolean withXMLDeclaration,
                  java.io.PrintWriter writer)

Serialize to the given writer, keeping it open when finished. If skipNonOverrides is true, any configuration whose values are all null will not be written.