org.waarp.openr66.database.data

Class DbHostAuth

java.lang.Object

org.waarp.common.database.data.AbstractDbData

org.waarp.openr66.database.data.AbstractDbDataDao<Host>

org.waarp.openr66.database.data.DbHostAuth

public class DbHostAuth
extends AbstractDbDataDao<Host>

Host Authentication Table object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbHostAuth.Columns

Nested classes/interfaces inherited from class org.waarp.common.database.data.AbstractDbData

AbstractDbData.UpdatedInfo

Field Summary

Fields

Modifier and Type	Field and Description
static int[]	dbTypes
static String	DEFAULT_CLIENT_ADDRESS
static DbHostAuth.Columns[]	indexes
protected static String	selectAllFields
static String	table

Fields inherited from class org.waarp.openr66.database.data.AbstractDbDataDao

JSON_MODEL, pojo, SHOULD_NOT_BE_CALLED

Fields inherited from class org.waarp.common.database.data.AbstractDbData

allFields, dbSession, isSaved, otherFields, primaryKey

Constructor Summary

Constructors

Constructor and Description
DbHostAuth(com.fasterxml.jackson.databind.node.ObjectNode source)
DbHostAuth(String hostid)
DbHostAuth(String hostid, String address, int port, boolean isSSL, byte[] hostkey, boolean adminrole, boolean isClient)

Method Summary

Modifier and Type	Method and Description
void	changeUpdatedInfo(AbstractDbData.UpdatedInfo info) Change UpdatedInfo status
protected void	checkValues()
static DbHostAuth[]	deleteAll() Delete all entries (used when purge and reload)
String	getAddress()
static DbHostAuth[]	getAllHosts() Get All DbHostAuth from database or from internal hashMap in case of no database support
protected AbstractDAO<Host>	getDao(boolean isCacheable)
static DbPreparedStatement	getFilterPrepareStament(DbSession session, String host, String addr)
static DbPreparedStatement	getFilterPrepareStament(DbSession session, String host, String addr, boolean ssl, boolean active)
static DbHostAuth	getFromStatement(DbPreparedStatement preparedStatement) For instance from Commander when getting updated information
String	getHostid()
byte[]	getHostkey()
static String	getJson(DbPreparedStatement preparedStatement, int limit) Write selected DbHostAuth to a Json String
String	getJsonAsString()
int	getPort()
protected String	getPrimaryField()
protected String	getPrimaryKey()
SocketAddress	getSocketAddress()
protected String	getTable()
static DbHostAuth[]	getUpdatedPreparedStatement()
static boolean	hasProxifiedHosts()
protected void	initObject() To setup primaryKey, otherFields, allFields.
boolean	isActive()
boolean	isAdminrole()
boolean	isClient() Test if the address is 0.0.0.0 for a client or isClient
boolean	isKeyValid(byte[] newkey) Is the given key a valid one
boolean	isNoAddress() True if the address is a client address (0.0.0.0) or if the port is < 0
boolean	isProxified()
boolean	isSsl()
void	setActive(boolean isActive)
void	setFromJson(com.fasterxml.jackson.databind.node.ObjectNode node, boolean ignorePrimaryKey) Set the values from the Json node to the current object (no database access)
protected void	setFromJson(String field, com.fasterxml.jackson.databind.JsonNode value)
void	setProxified(boolean isProxified)
String	toSpecializedHtml(R66Session session, String body, boolean crypted)
String	toString()

Methods inherited from class org.waarp.openr66.database.data.AbstractDbDataDao

asJson, delete, exist, getInsertAllValues, getJson, getSelectAllFields, getUpdateAllFields, getValues, getWherePrimaryKey, insert, select, setFromArray, setPrimaryKey, setToArray, toJson, update, validateLength, validateLength

Methods inherited from class org.waarp.common.database.data.AbstractDbData

getAllFields, getTrueValue, setTrueValue, setValues

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CLIENT_ADDRESS

public static final String DEFAULT_CLIENT_ADDRESS

See Also:

Constant Field Values

dbTypes

public static final int[] dbTypes

table

public static final String table

See Also:

Constant Field Values

selectAllFields

protected static final String selectAllFields

indexes

public static final DbHostAuth.Columns[] indexes

Constructor Detail

DbHostAuth

public DbHostAuth(String hostid,
                  String address,
                  int port,
                  boolean isSSL,
                  byte[] hostkey,
                  boolean adminrole,
                  boolean isClient)
           throws WaarpDatabaseSqlException

Parameters:

hostid -

address -

port -

isSSL -

hostkey -

adminrole -

isClient -

Throws:

WaarpDatabaseSqlException

DbHostAuth

public DbHostAuth(com.fasterxml.jackson.databind.node.ObjectNode source)
           throws WaarpDatabaseSqlException

Throws:

WaarpDatabaseSqlException

DbHostAuth

public DbHostAuth(String hostid)
           throws WaarpDatabaseException

Parameters:

hostid -

Throws:

WaarpDatabaseException

Method Detail

initObject

protected final void initObject()

Description copied from class: AbstractDbData

To setup primaryKey, otherFields, allFields. Note this initObject is called within constructor of AbstractDbData. Be careful that no data is actually initialized at this stage.

Overrides:

initObject in class AbstractDbDataDao<Host>

getTable

protected final String getTable()

Specified by:

getTable in class AbstractDbDataDao<Host>

getDao

protected final AbstractDAO<Host> getDao(boolean isCacheable)
                                  throws DAOConnectionException

Specified by:

getDao in class AbstractDbDataDao<Host>

Throws:

DAOConnectionException

getPrimaryKey

protected final String getPrimaryKey()

Specified by:

getPrimaryKey in class AbstractDbDataDao<Host>

getPrimaryField

protected final String getPrimaryField()

Specified by:

getPrimaryField in class AbstractDbDataDao<Host>

checkValues

protected final void checkValues()
                          throws WaarpDatabaseSqlException

Specified by:

checkValues in class AbstractDbDataDao<Host>

Throws:

WaarpDatabaseSqlException

setFromJson

public final void setFromJson(com.fasterxml.jackson.databind.node.ObjectNode node,
                              boolean ignorePrimaryKey)
                       throws WaarpDatabaseSqlException

Description copied from class: AbstractDbDataDao

Set the values from the Json node to the current object (no database access)

Overrides:

setFromJson in class AbstractDbDataDao<Host>

ignorePrimaryKey - True will ignore primaryKey from Json

Throws:

WaarpDatabaseSqlException

setFromJson

protected final void setFromJson(String field,
                                 com.fasterxml.jackson.databind.JsonNode value)

Specified by:

setFromJson in class AbstractDbDataDao<Host>

deleteAll

public static DbHostAuth[] deleteAll()
                              throws WaarpDatabaseException

Delete all entries (used when purge and reload)

Returns:

the previous existing array of DbRule

Throws:

WaarpDatabaseException

getAllHosts

public static DbHostAuth[] getAllHosts()
                                throws WaarpDatabaseNoConnectionException

Get All DbHostAuth from database or from internal hashMap in case of no database support

Returns:

the array of DbHostAuth

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getFromStatement

public static DbHostAuth getFromStatement(DbPreparedStatement preparedStatement)
                                   throws WaarpDatabaseNoConnectionException,
                                          WaarpDatabaseSqlException

For instance from Commander when getting updated information

Parameters:

preparedStatement -

Returns:

the next updated DbHostAuth

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getUpdatedPreparedStatement

public static DbHostAuth[] getUpdatedPreparedStatement()
                                                throws WaarpDatabaseNoConnectionException

Throws:

WaarpDatabaseNoConnectionException

getFilterPrepareStament

public static DbPreparedStatement getFilterPrepareStament(DbSession session,
                                                          String host,
                                                          String addr,
                                                          boolean ssl,
                                                          boolean active)
                                                   throws WaarpDatabaseNoConnectionException,
                                                          WaarpDatabaseSqlException

Parameters:

session -

host -

addr -

ssl -

active -

Returns:

the DbPreparedStatement according to the filter

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getFilterPrepareStament

public static DbPreparedStatement getFilterPrepareStament(DbSession session,
                                                          String host,
                                                          String addr)
                                                   throws WaarpDatabaseNoConnectionException,
                                                          WaarpDatabaseSqlException

Parameters:

session -

host -

addr -

Returns:

the DbPreparedStatement according to the filter

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

changeUpdatedInfo

public final void changeUpdatedInfo(AbstractDbData.UpdatedInfo info)

Description copied from class: AbstractDbDataDao

Change UpdatedInfo status

Specified by:

changeUpdatedInfo in class AbstractDbDataDao<Host>

isActive

public final boolean isActive()

Returns:

the isActive

setActive

public final void setActive(boolean isActive)

Parameters:

isActive - the isActive to set

isProxified

public final boolean isProxified()

Returns:

the isProxified

setProxified

public final void setProxified(boolean isProxified)

Parameters:

isProxified - the isProxified to set

isKeyValid

public final boolean isKeyValid(byte[] newkey)

Is the given key a valid one

Parameters:

newkey -

Returns:

True if the key is valid (or any key is valid)

getHostkey

public final byte[] getHostkey()

Returns:

the hostkey

isAdminrole

public final boolean isAdminrole()

Returns:

the adminrole

isClient

public final boolean isClient()

Test if the address is 0.0.0.0 for a client or isClient

Returns:

True if the address is a client address (0.0.0.0) or isClient

isNoAddress

public final boolean isNoAddress()

True if the address is a client address (0.0.0.0) or if the port is < 0

Returns:

True if the address is a client address (0.0.0.0) or if the port is < 0

getSocketAddress

public final SocketAddress getSocketAddress()
                                     throws IllegalArgumentException

Returns:

the SocketAddress from the address and port

Throws:

IllegalArgumentException - when the address is for a Client and therefore cannot be checked

isSsl

public final boolean isSsl()

Returns:

True if this Host ref is with SSL support

getHostid

public final String getHostid()

Returns:

the hostid

getAddress

public final String getAddress()

Returns:

the address

getPort

public final int getPort()

Returns:

the port

toString

public final String toString()

Overrides:

toString in class Object

getJson

public static String getJson(DbPreparedStatement preparedStatement,
                             int limit)
                      throws WaarpDatabaseNoConnectionException,
                             WaarpDatabaseSqlException

Write selected DbHostAuth to a Json String

Parameters:

preparedStatement -

Returns:

the associated Json String

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getJsonAsString

public final String getJsonAsString()

Returns:

the Json string for this

toSpecializedHtml

public final String toSpecializedHtml(R66Session session,
                                      String body,
                                      boolean crypted)

Parameters:

session -

body -

crypted - True if the Key is kept crypted, False it will be in clear form

Returns:

the runner in Html format specified by body by replacing all instance of fields

hasProxifiedHosts

public static boolean hasProxifiedHosts()

Returns:

True if any of the server has the isProxified property