Package com.exedio.cope.misc

Class ConnectToken

java.lang.Object

com.exedio.cope.misc.ConnectToken

All Implemented Interfaces:

AutoCloseable

public final class ConnectToken
extends Object
implements AutoCloseable

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	didConnect()
int	getID()
Date	getIssueDate()
Model	getModel()
String	getName()
static ConnectProperties	getProperties(Model model)
static List<ConnectToken>	getTokens(Model model)	Returns the collection of open ConnectTokens on the model.
boolean	isReturned()
static ConnectToken	issue(Model model, ConnectProperties properties, String tokenName)	Deprecated. Use issue(Model, String) instead.
static ConnectToken	issue(Model model, String tokenName)	Connects the model to the database described in the properties, if the model is not already connected.
static ConnectToken	issueIfConnected(Model model, String tokenName)	Issues a ConnectToken, if the model is already connected.
static ConnectProperties	removeProperties(Model model)	Deprecated. Use removePropertiesVoid instead.
static void	removePropertiesVoid(Model model)
boolean	returnIt()	Deprecated. Use returnStrictly() instead
boolean	returnItConditionally()	Return false, if token was already returned.
ConnectToken	returnOnFailureOf(Consumer<ConnectToken> target)	Calls target.
boolean	returnStrictly()
static void	setProperties(Model model, ConnectProperties properties)	Sets the connect properties for the given model.
static void	setProperties(Model model, Supplier<ConnectProperties> properties)	Sets the connect properties for the given model.
String	toString()
boolean	wasConditional()	Returns true, if this token was issued by issueIfConnected(Model, String).

Methods inherited from class java.lang.Object

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

Method Detail

getModel

public Model getModel()

getID

public int getID()

getIssueDate

public Date getIssueDate()

getName

public String getName()

wasConditional

public boolean wasConditional()

Returns true, if this token was issued by issueIfConnected(Model, String). Returns false, if this token was issued by issue(Model, ConnectProperties, String).

didConnect

public boolean didConnect()

isReturned

public boolean isReturned()

returnStrictly

public boolean returnStrictly()

Throws:

IllegalArgumentException - if token was already returned. You may want to use returnItConditionally() instead.

returnItConditionally

public boolean returnItConditionally()

Return false, if token was already returned. You may want to use returnStrictly() instead.

close

public void close()

Specified by:

close in interface AutoCloseable

returnOnFailureOf

public ConnectToken returnOnFailureOf(Consumer<ConnectToken> target)

Calls target. If target fails with an exception, this token is returned.

toString

public String toString()

Overrides:

toString in class Object

setProperties

public static void setProperties(Model model,
                                 ConnectProperties properties)

Sets the connect properties for the given model. Enables usage of issue(Model, String), issueIfConnected(Model, String), getTokens(Model).

See Also:

setProperties(Model, Supplier), removePropertiesVoid(Model)

setProperties

public static void setProperties(Model model,
                                 Supplier<ConnectProperties> properties)

Sets the connect properties for the given model. Enables usage of issue(Model, String), issueIfConnected(Model, String), getTokens(Model).

See Also:

setProperties(Model, ConnectProperties), removePropertiesVoid(Model)

getProperties

public static ConnectProperties getProperties(Model model)

removePropertiesVoid

public static void removePropertiesVoid(Model model)

See Also:

setProperties(Model, ConnectProperties)

removeProperties

@Deprecated
public static ConnectProperties removeProperties(Model model)

Deprecated.

Use removePropertiesVoid instead. This method may fail at computing the result if used together with setProperties(Model, Supplier) and the supplier fails.

See Also:

setProperties(Model, ConnectProperties)

issue

public static ConnectToken issue(Model model,
                                 String tokenName)

Connects the model to the database described in the properties, if the model is not already connected. Can be called multiple times, but only the first time takes effect.

Usually you may want to use this method, if you want to connect this model from different servlets with equal properties in an undefined order.

issueIfConnected

public static ConnectToken issueIfConnected(Model model,
                                            String tokenName)

Issues a ConnectToken, if the model is already connected. Otherwise the method returns null.

Usually you may want to use this method, if you want to do something if the model is already connected, but in that case with a guarantee, that the model is not disconnected while doing those things.

Tokens returned by this method always do have didConnect()==false.

See Also:

wasConditional()

getTokens

public static List<ConnectToken> getTokens(Model model)

Returns the collection of open ConnectTokens on the model.

Returns an unmodifiable snapshot of the actual data, so iterating over the collection on a live server cannot cause ConcurrentModificationExceptions.

returnIt

@Deprecated
public boolean returnIt()

Deprecated.

Use returnStrictly() instead

issue

@Deprecated
public static ConnectToken issue(Model model,
                                 ConnectProperties properties,
                                 String tokenName)

Deprecated.

Use issue(Model, String) instead. Parameter properties is ignored.

Parameters:

properties - is ignored