com.aspc.commander.dbobj

Class DBServer

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.commander.dbobj.DBServer

All Implemented Interfaces:

SecondaryCacheGroup

public class DBServer
extends DBObject

the server list.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

16 April 2006

Author:

Nigel Leck

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID the server list
static java.lang.String	DBCLASS_NAME the server list

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBServer(DBClass dbClass, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static DBServer	create(MutableDataSource mds) Make a new instance of this class.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) return the secure URL
protected void	extSetValue(DBField field, java.lang.Object currentValue, FldParams params) stript the protocol.
DBSystemPropertyMatch	findAreaProperty(java.lang.String... args) To check if environment variable is set.
DBCluster	findCluster(java.lang.String... args) The cluster for this server.
static DBServer	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBSystemPropertyMatch	getAreaProperty(java.lang.String... args)
DBCluster	getCluster(java.lang.String... args)
java.lang.String	getCode(java.lang.String... args)
int	getFallBackLevel(java.lang.String... args)
int	getHttpPort(java.lang.String... args)
int	getHttpsPort(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getLoginURL() Provides the login URL.
int	getPriority(java.lang.String... args)
java.lang.String	getSecureProtocol(java.lang.String... args)
java.lang.String	getServerHostname(java.lang.String... args)
java.lang.String	getTransportProtocol(java.lang.String... args)
java.lang.String	getUsersAllowCriteria(java.lang.String... args)
java.lang.String	getUsersDenyCriteria(java.lang.String... args)
boolean	isApplicable(java.lang.String... args)
boolean	isDeniedUserLogin(java.lang.String... args)
boolean	isEnabled(java.lang.String... args)
static DBQuery<DBServer>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBServer	setAreaProperty(com.aspc.dal.dbobj.misc.DBSystemPropertyMatch value, java.lang.String... args)
DBServer	setCluster(com.aspc.dal.commander.dbobj.DBCluster value, java.lang.String... args)
DBServer	setCode(java.lang.String value, java.lang.String... args)
DBServer	setEnabled(boolean value, java.lang.String... args)
DBServer	setFallBackLevel(int value, java.lang.String... args)
DBServer	setHttpPort(int value, java.lang.String... args)
DBServer	setHttpsPort(int value, java.lang.String... args)
DBServer	setID(int value, java.lang.String... args)
DBServer	setServerHostname(java.lang.String value, java.lang.String... args)
DBServer	setUsersAllowCriteria(java.lang.String value, java.lang.String... args)
DBServer	setUsersDenyCriteria(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, extValidateDelete, extValidateField, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

the server list

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

the server list

Constructor Detail

DBServer

public DBServer(DBClass dbClass,
                DataSource dataSource)
         throws java.lang.Exception

Std. DBObject constructor.

Parameters:

dbClass - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public DBServer setID(int value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

isApplicable

@CheckReturnValue
public boolean isApplicable(java.lang.String... args)

getAreaProperty

@CheckReturnValue
 @Nullable
public DBSystemPropertyMatch getAreaProperty(java.lang.String... args)

findAreaProperty

@CheckReturnValue
 @Nonnull
public final DBSystemPropertyMatch findAreaProperty(java.lang.String... args)
                                                                         throws NotFoundException

To check if environment variable is set.

--> DBSystemPropertyMatch (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBSystemPropertyMatch

Throws:

NotFoundException - DBSystemPropertyMatch was not found

setAreaProperty

@Nonnull
public DBServer setAreaProperty(com.aspc.dal.dbobj.misc.DBSystemPropertyMatch value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getCluster

@CheckReturnValue
 @Nullable
public DBCluster getCluster(java.lang.String... args)

findCluster

@CheckReturnValue
 @Nonnull
public final DBCluster findCluster(java.lang.String... args)
                                                        throws NotFoundException

The cluster for this server.

--> DBCluster (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBCluster

Throws:

NotFoundException - DBCluster was not found

setCluster

@Nonnull
public DBServer setCluster(com.aspc.dal.commander.dbobj.DBCluster value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getCode

@CheckReturnValue
 @Nonnull
public java.lang.String getCode(java.lang.String... args)

setCode

@Nonnull
public DBServer setCode(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

isDeniedUserLogin

@CheckReturnValue
public boolean isDeniedUserLogin(java.lang.String... args)

isEnabled

@CheckReturnValue
public boolean isEnabled(java.lang.String... args)

setEnabled

@Nonnull
public DBServer setEnabled(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getFallBackLevel

@CheckReturnValue
public int getFallBackLevel(java.lang.String... args)

setFallBackLevel

@Nonnull
public DBServer setFallBackLevel(int value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getHttpPort

@CheckReturnValue
public int getHttpPort(java.lang.String... args)

setHttpPort

@Nonnull
public DBServer setHttpPort(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getHttpsPort

@CheckReturnValue
public int getHttpsPort(java.lang.String... args)

setHttpsPort

@Nonnull
public DBServer setHttpsPort(int value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getPriority

@CheckReturnValue
public int getPriority(java.lang.String... args)

getSecureProtocol

@CheckReturnValue
 @Nonnull
public java.lang.String getSecureProtocol(java.lang.String... args)

getServerHostname

@CheckReturnValue
 @Nonnull
public java.lang.String getServerHostname(java.lang.String... args)

setServerHostname

@Nonnull
public DBServer setServerHostname(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getTransportProtocol

@CheckReturnValue
 @Nonnull
public java.lang.String getTransportProtocol(java.lang.String... args)

getUsersAllowCriteria

@CheckReturnValue
 @Nonnull
public java.lang.String getUsersAllowCriteria(java.lang.String... args)

setUsersAllowCriteria

@Nonnull
public DBServer setUsersAllowCriteria(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getUsersDenyCriteria

@CheckReturnValue
 @Nonnull
public java.lang.String getUsersDenyCriteria(java.lang.String... args)

setUsersDenyCriteria

@Nonnull
public DBServer setUsersDenyCriteria(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBServer create(@Nonnull
                                                          MutableDataSource mds)
                                                   throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<DBServer> makeQuery(@Nonnull
                                                                      DataSource ds)
                                                               throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static DBServer findKey(@Nonnull
                                                           DataSource ds,
                                                           int key)
                                                    throws NotFoundException,
                                                           java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

return the secure URL

Overrides:

extGetDerivedValue in class DBObject

Parameters:

params - The parameters for this field eg. language= or default=

field - The field to get

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

extSetValue

protected void extSetValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object currentValue,
                           @Nullable
                           FldParams params)
                    throws java.lang.Exception

stript the protocol.

Overrides:

extSetValue in class DBObject

Parameters:

field - The field that is being changed

currentValue - The new value

params - The extra parameters

Throws:

java.lang.Exception - A serious problem. In general validation is done later.

getLoginURL

public java.lang.String getLoginURL()

Provides the login URL. If SSL is enabled, it will be HTTPS URL. Otherwise, HTTP URL will be returned.

Returns:

URL