org.dbflute.hook

クラス AccessContext

java.lang.Object

org.dbflute.hook.AccessContext

public class AccessContext
extends Object

The context of DB access. (basically for CommonColumnAutoSetup)

作成者:

jflute

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static interface	AccessContext.AccessContextHolder The holder of for access context.
static interface	AccessContext.AccessDateProvider The provider interface of access date.
static interface	AccessContext.AccessLocalDateProvider The provider interface of access local date.
static interface	AccessContext.AccessLocalDateTimeProvider The provider interface of access local date-time.
static interface	AccessContext.AccessModuleProvider The provider interface of access module.
static interface	AccessContext.AccessProcessProvider The provider interface of access process.
static interface	AccessContext.AccessTimestampProvider The provider interface of access time-stamp.
static interface	AccessContext.AccessUserProvider The provider interface of access user.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected Date	_accessDate
protected AccessContext.AccessDateProvider	_accessDateProvider
protected LocalDate	_accessLocalDate
protected AccessContext.AccessLocalDateProvider	_accessLocalDateProvider
protected LocalDateTime	_accessLocalDateTime
protected AccessContext.AccessLocalDateTimeProvider	_accessLocalDateTimeProvider
protected String	_accessModule
protected AccessContext.AccessModuleProvider	_accessModuleProvider
protected String	_accessProcess
protected AccessContext.AccessProcessProvider	_accessProcessProvider
protected Timestamp	_accessTimestamp
protected AccessContext.AccessTimestampProvider	_accessTimestampProvider
protected String	_accessUser
protected AccessContext.AccessUserProvider	_accessUserProvider
protected Map<String,Object>	_accessValueMap The map of access value, you can freely add your item value.
protected static AccessContext.AccessContextHolder	_defaultHolder The default holder for access context, using thread local.
protected static ThreadLocal<AccessContext>	_defaultThreadLocal The default thread-local for this.
protected static AccessContext.AccessContextHolder	_holder The holder for access context, might be changed.
protected static boolean	_locked Is this static world locked?

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
AccessContext()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected static void	assertNotLocked() Assert this is not locked.
static void	clearAccessContextOnThread() Clear access-context on thread.
static AccessContext	getAccessContextOnThread() Get access-context on thread.
Date	getAccessDate()
static Date	getAccessDateOnThread() Get access date on thread.
AccessContext.AccessDateProvider	getAccessDateProvider()
LocalDate	getAccessLocalDate()
static LocalDate	getAccessLocalDateOnThread() Get access local date on thread.
AccessContext.AccessLocalDateProvider	getAccessLocalDateProvider()
LocalDateTime	getAccessLocalDateTime()
static LocalDateTime	getAccessLocalDateTimeOnThread() Get access local date-time on thread.
AccessContext.AccessLocalDateTimeProvider	getAccessLocalDateTimeProvider()
String	getAccessModule()
static String	getAccessModuleOnThread() Get access module on thread.
AccessContext.AccessModuleProvider	getAccessModuleProvider()
String	getAccessProcess()
static String	getAccessProcessOnThread() Get access process on thread.
AccessContext.AccessProcessProvider	getAccessProcessProvider()
Timestamp	getAccessTimestamp()
static Timestamp	getAccessTimestampOnThread() Get access time-stamp on thread.
AccessContext.AccessTimestampProvider	getAccessTimestampProvider()
String	getAccessUser()
static String	getAccessUserOnThread() Get access user on thread.
AccessContext.AccessUserProvider	getAccessUserProvider()
Map<String,Object>	getAccessValueMap()
static Object	getAccessValueOnThread(String key) Get access value on thread.
protected static AccessContext.AccessContextHolder	getActiveHolder() Get the active holder for access context.
static boolean	isExistAccessContextOnThread() Is existing access-context on thread?
static boolean	isLocked() Is this static world locked?
protected static String	ln()
static void	lock() Lock this static world, e.g. not to set the holder of thread-local.
void	registerAccessValue(String key, Object value) Register the access value by the key.
static void	setAccessContextOnThread(AccessContext accessContext) Set access-context on thread.
void	setAccessDate(Date accessDate)
void	setAccessDateProvider(AccessContext.AccessDateProvider accessDateProvider)
void	setAccessLocalDate(LocalDate accessLocalDate)
void	setAccessLocalDateProvider(AccessContext.AccessLocalDateProvider accessLocalDateProvider)
void	setAccessLocalDateTime(LocalDateTime accessLocalDateTime)
void	setAccessLocalDateTimeProvider(AccessContext.AccessLocalDateTimeProvider accessLocalDateTimeProvider)
void	setAccessModule(String accessModule)
void	setAccessModuleProvider(AccessContext.AccessModuleProvider accessModuleProvider)
void	setAccessProcess(String accessProcess)
void	setAccessProcessProvider(AccessContext.AccessProcessProvider accessProcessProvider)
void	setAccessTimestamp(Timestamp accessTimestamp)
void	setAccessTimestampProvider(AccessContext.AccessTimestampProvider accessTimestampProvider)
void	setAccessUser(String accessUser)
void	setAccessUserProvider(AccessContext.AccessUserProvider accessUserProvider)
protected static void	throwAccessContextNotFoundException(String methodName)
protected static void	throwAccessContextNoValueException(String methodName, String capPropName, String aliasName)
String	toString()
static void	unlock() Unlock this static world, e.g. to set the holder of thread-local.
static void	useSurrogateHolder(AccessContext.AccessContextHolder holder) Use the surrogate holder for access context.

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

_defaultThreadLocal

protected static final ThreadLocal<AccessContext> _defaultThreadLocal

The default thread-local for this.

_defaultHolder

protected static final AccessContext.AccessContextHolder _defaultHolder

The default holder for access context, using thread local. (NotNull)

_holder

protected static AccessContext.AccessContextHolder _holder

The holder for access context, might be changed. (NotNull: null setting is not allowed)

_locked

protected static boolean _locked

Is this static world locked? e.g. you should unlock it to set your own provider.

_accessLocalDate

protected LocalDate _accessLocalDate

_accessLocalDateProvider

protected AccessContext.AccessLocalDateProvider _accessLocalDateProvider

_accessLocalDateTime

protected LocalDateTime _accessLocalDateTime

_accessLocalDateTimeProvider

protected AccessContext.AccessLocalDateTimeProvider _accessLocalDateTimeProvider

_accessDate

protected Date _accessDate

_accessDateProvider

protected AccessContext.AccessDateProvider _accessDateProvider

_accessTimestamp

protected Timestamp _accessTimestamp

_accessTimestampProvider

protected AccessContext.AccessTimestampProvider _accessTimestampProvider

_accessUser

protected String _accessUser

_accessUserProvider

protected AccessContext.AccessUserProvider _accessUserProvider

_accessProcess

protected String _accessProcess

_accessProcessProvider

protected AccessContext.AccessProcessProvider _accessProcessProvider

_accessModule

protected String _accessModule

_accessModuleProvider

protected AccessContext.AccessModuleProvider _accessModuleProvider

_accessValueMap

protected Map<String,Object> _accessValueMap

The map of access value, you can freely add your item value. (NullAllowed: means no use)

コンストラクタの詳細

AccessContext

public AccessContext()

メソッドの詳細

getAccessContextOnThread

public static AccessContext getAccessContextOnThread()

Get access-context on thread.

戻り値:

The context of DB access. (NullAllowed)

setAccessContextOnThread

public static void setAccessContextOnThread(AccessContext accessContext)

Set access-context on thread.

パラメータ:

accessContext - The context of DB access. (NotNull)

isExistAccessContextOnThread

public static boolean isExistAccessContextOnThread()

Is existing access-context on thread?

戻り値:

The determination, true or false.

clearAccessContextOnThread

public static void clearAccessContextOnThread()

Clear access-context on thread.

getActiveHolder

protected static AccessContext.AccessContextHolder getActiveHolder()

Get the active holder for access context.

戻り値:

The holder instance to handle access context. (NotNull)

useSurrogateHolder

public static void useSurrogateHolder(AccessContext.AccessContextHolder holder)

Use the surrogate holder for access context. (automatically locked after setting)
You should call this in application initialization if it needs.

パラメータ:

holder - The holder instance. (NullAllowed: if null, use default holder)

isLocked

public static boolean isLocked()

Is this static world locked?

戻り値:

The determination, true or false.

lock

public static void lock()

Lock this static world, e.g. not to set the holder of thread-local.

unlock

public static void unlock()

Unlock this static world, e.g. to set the holder of thread-local.

assertNotLocked

protected static void assertNotLocked()

Assert this is not locked.

getAccessLocalDateOnThread

public static LocalDate getAccessLocalDateOnThread()

Get access local date on thread.
If it couldn't get access local date from access-context, it returns null.

戻り値:

The local date that specifies access time. (NotNull)

getAccessLocalDateTimeOnThread

public static LocalDateTime getAccessLocalDateTimeOnThread()

Get access local date-time on thread.
If it couldn't get access local date-time from access-context, it returns null.

戻り値:

The local date-time that specifies access time. (NotNull)

getAccessDateOnThread

public static Date getAccessDateOnThread()

Get access date on thread.
If it couldn't get access date from access-context, it returns current date of DBFluteSystem.

戻り値:

The date that specifies access time. (NotNull)

getAccessTimestampOnThread

public static Timestamp getAccessTimestampOnThread()

Get access time-stamp on thread.
If it couldn't get access time-stamp from access-context, it returns current time-stamp of DBFluteSystem.

戻り値:

The time-stamp that specifies access time. (NotNull)

getAccessUserOnThread

public static String getAccessUserOnThread()

Get access user on thread.

戻り値:

The expression for access user. (NotNull)

getAccessProcessOnThread

public static String getAccessProcessOnThread()

Get access process on thread.

戻り値:

The expression for access module. (NotNull)

getAccessModuleOnThread

public static String getAccessModuleOnThread()

Get access module on thread.

戻り値:

The expression for access module. (NotNull)

getAccessValueOnThread

public static Object getAccessValueOnThread(String key)

Get access value on thread.

パラメータ:

key - Key. (NotNull)

戻り値:

The object of access value. (NotNull)

throwAccessContextNotFoundException

protected static void throwAccessContextNotFoundException(String methodName)

throwAccessContextNoValueException

protected static void throwAccessContextNoValueException(String methodName,
                                                         String capPropName,
                                                         String aliasName)

ln

protected static String ln()

toString

public String toString()

オーバーライド:

toString クラス内 Object

getAccessLocalDate

public LocalDate getAccessLocalDate()

setAccessLocalDate

public void setAccessLocalDate(LocalDate accessLocalDate)

getAccessLocalDateProvider

public AccessContext.AccessLocalDateProvider getAccessLocalDateProvider()

setAccessLocalDateProvider

public void setAccessLocalDateProvider(AccessContext.AccessLocalDateProvider accessLocalDateProvider)

getAccessLocalDateTime

public LocalDateTime getAccessLocalDateTime()

setAccessLocalDateTime

public void setAccessLocalDateTime(LocalDateTime accessLocalDateTime)

getAccessLocalDateTimeProvider

public AccessContext.AccessLocalDateTimeProvider getAccessLocalDateTimeProvider()

setAccessLocalDateTimeProvider

public void setAccessLocalDateTimeProvider(AccessContext.AccessLocalDateTimeProvider accessLocalDateTimeProvider)

getAccessDate

public Date getAccessDate()

setAccessDate

public void setAccessDate(Date accessDate)

getAccessDateProvider

public AccessContext.AccessDateProvider getAccessDateProvider()

setAccessDateProvider

public void setAccessDateProvider(AccessContext.AccessDateProvider accessDateProvider)

getAccessTimestamp

public Timestamp getAccessTimestamp()

setAccessTimestamp

public void setAccessTimestamp(Timestamp accessTimestamp)

getAccessTimestampProvider

public AccessContext.AccessTimestampProvider getAccessTimestampProvider()

setAccessTimestampProvider

public void setAccessTimestampProvider(AccessContext.AccessTimestampProvider accessTimestampProvider)

getAccessUser

public String getAccessUser()

setAccessUser

public void setAccessUser(String accessUser)

getAccessUserProvider

public AccessContext.AccessUserProvider getAccessUserProvider()

setAccessUserProvider

public void setAccessUserProvider(AccessContext.AccessUserProvider accessUserProvider)

getAccessProcess

public String getAccessProcess()

setAccessProcess

public void setAccessProcess(String accessProcess)

getAccessProcessProvider

public AccessContext.AccessProcessProvider getAccessProcessProvider()

setAccessProcessProvider

public void setAccessProcessProvider(AccessContext.AccessProcessProvider accessProcessProvider)

getAccessModule

public String getAccessModule()

setAccessModule

public void setAccessModule(String accessModule)

getAccessModuleProvider

public AccessContext.AccessModuleProvider getAccessModuleProvider()

setAccessModuleProvider

public void setAccessModuleProvider(AccessContext.AccessModuleProvider accessModuleProvider)

getAccessValueMap

public Map<String,Object> getAccessValueMap()

registerAccessValue

public void registerAccessValue(String key,
                                Object value)

Register the access value by the key.

パラメータ:

key - The key of the access value. (NotNull)

value - The value as object. (NullAllowed)