Class CloudMembershipProvider
- java.lang.Object
-
- org.apache.catalina.tribes.membership.MembershipProviderBase
-
- org.apache.catalina.tribes.membership.cloud.CloudMembershipProvider
-
- All Implemented Interfaces:
ChannelListener,Heartbeat,MembershipProvider
- Direct Known Subclasses:
DNSMembershipProvider,KubernetesMembershipProvider
public abstract class CloudMembershipProvider extends MembershipProviderBase implements Heartbeat, ChannelListener
-
-
Field Summary
Fields Modifier and Type Field Description protected intconnectionTimeoutprotected static java.lang.StringCUSTOM_ENV_PREFIXprotected longexpirationTimeprotected java.util.Map<java.lang.String,java.lang.String>headersprotected java.lang.StringlocalIpprotected java.security.MessageDigestmd5protected intportprotected intreadTimeoutprotected static StringManagersmprotected java.time.InstantstartTimeprotected StreamProviderstreamProviderprotected java.lang.Stringurl-
Fields inherited from class org.apache.catalina.tribes.membership.MembershipProviderBase
executor, membership, membershipListener, service
-
-
Constructor Summary
Constructors Constructor Description CloudMembershipProvider()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description booleanaccept(java.io.Serializable msg, Member sender)Invoked by the channel to determine if the listener will process this message or not.protected abstract Member[]fetchMembers()Fetch current cluster members from the cloud orchestration.protected static java.lang.StringgetEnv(java.lang.String... keys)Get value of environment variable.protected java.lang.StringgetNamespace()Get the Kubernetes namespace, or "tomcat" if the Kubernetes environment variable cannot be found (with a warning log about the missing namespace).voidheartbeat()Heartbeat invocation for resources cleanup etcvoidinit(java.util.Properties properties)voidmessageReceived(java.io.Serializable msg, Member sender)Receive a message from the channelvoidstart(int level)booleanstop(int level)protected voidupdateMember(Member member, boolean add)Add or remove specified member.-
Methods inherited from class org.apache.catalina.tribes.membership.MembershipProviderBase
getMember, getMembers, hasMembers, setMembershipListener, setMembershipService
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.catalina.tribes.ChannelListener
equals, hashCode
-
-
-
-
Field Detail
-
sm
protected static final StringManager sm
-
CUSTOM_ENV_PREFIX
protected static final java.lang.String CUSTOM_ENV_PREFIX
- See Also:
- Constant Field Values
-
url
protected java.lang.String url
-
streamProvider
protected StreamProvider streamProvider
-
connectionTimeout
protected int connectionTimeout
-
readTimeout
protected int readTimeout
-
startTime
protected java.time.Instant startTime
-
md5
protected java.security.MessageDigest md5
-
headers
protected java.util.Map<java.lang.String,java.lang.String> headers
-
localIp
protected java.lang.String localIp
-
port
protected int port
-
expirationTime
protected long expirationTime
-
-
Method Detail
-
getEnv
protected static java.lang.String getEnv(java.lang.String... keys)
Get value of environment variable.- Parameters:
keys- the environment variables- Returns:
- the env variables values, or null if not found
-
getNamespace
protected java.lang.String getNamespace()
Get the Kubernetes namespace, or "tomcat" if the Kubernetes environment variable cannot be found (with a warning log about the missing namespace).- Returns:
- the namespace
-
init
public void init(java.util.Properties properties) throws java.io.IOException- Specified by:
initin interfaceMembershipProvider- Overrides:
initin classMembershipProviderBase- Throws:
java.io.IOException
-
start
public void start(int level) throws java.lang.Exception- Specified by:
startin interfaceMembershipProvider- Throws:
java.lang.Exception
-
stop
public boolean stop(int level) throws java.lang.Exception- Specified by:
stopin interfaceMembershipProvider- Throws:
java.lang.Exception
-
heartbeat
public void heartbeat()
Description copied from interface:HeartbeatHeartbeat invocation for resources cleanup etc
-
fetchMembers
protected abstract Member[] fetchMembers()
Fetch current cluster members from the cloud orchestration.- Returns:
- the member array
-
updateMember
protected void updateMember(Member member, boolean add)
Add or remove specified member.- Parameters:
member- the member to addadd- true if the member is added, false otherwise
-
messageReceived
public void messageReceived(java.io.Serializable msg, Member sender)Description copied from interface:ChannelListenerReceive a message from the channel- Specified by:
messageReceivedin interfaceChannelListener- Parameters:
msg- Serializablesender- - the source of the message
-
accept
public boolean accept(java.io.Serializable msg, Member sender)Description copied from interface:ChannelListenerInvoked by the channel to determine if the listener will process this message or not.- Specified by:
acceptin interfaceChannelListener- Parameters:
msg- Serializablesender- Member- Returns:
- boolean
-
-