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 SummaryFields 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.MembershipProviderBaseexecutor, membership, membershipListener, service
 
- 
 - 
Constructor SummaryConstructors Constructor Description CloudMembershipProvider()
 - 
Method SummaryAll 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.MembershipProviderBasegetMember, getMembers, hasMembers, setMembershipListener, setMembershipService
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface org.apache.catalina.tribes.ChannelListenerequals, hashCode
 
- 
 
- 
- 
- 
Field Detail- 
smprotected static final StringManager sm 
 - 
CUSTOM_ENV_PREFIXprotected static final java.lang.String CUSTOM_ENV_PREFIX - See Also:
- Constant Field Values
 
 - 
urlprotected java.lang.String url 
 - 
streamProviderprotected StreamProvider streamProvider 
 - 
connectionTimeoutprotected int connectionTimeout 
 - 
readTimeoutprotected int readTimeout 
 - 
startTimeprotected java.time.Instant startTime 
 - 
md5protected java.security.MessageDigest md5 
 - 
headersprotected java.util.Map<java.lang.String,java.lang.String> headers 
 - 
localIpprotected java.lang.String localIp 
 - 
portprotected int port 
 - 
expirationTimeprotected long expirationTime 
 
- 
 - 
Method Detail- 
getEnvprotected 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
 
 - 
getNamespaceprotected 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
 
 - 
initpublic void init(java.util.Properties properties) throws java.io.IOException- Specified by:
- initin interface- MembershipProvider
- Overrides:
- initin class- MembershipProviderBase
- Throws:
- java.io.IOException
 
 - 
startpublic void start(int level) throws java.lang.Exception- Specified by:
- startin interface- MembershipProvider
- Throws:
- java.lang.Exception
 
 - 
stoppublic boolean stop(int level) throws java.lang.Exception- Specified by:
- stopin interface- MembershipProvider
- Throws:
- java.lang.Exception
 
 - 
heartbeatpublic void heartbeat() Description copied from interface:HeartbeatHeartbeat invocation for resources cleanup etc
 - 
fetchMembersprotected abstract Member[] fetchMembers() Fetch current cluster members from the cloud orchestration.- Returns:
- the member array
 
 - 
updateMemberprotected void updateMember(Member member, boolean add) Add or remove specified member.- Parameters:
- member- the member to add
- add- true if the member is added, false otherwise
 
 - 
messageReceivedpublic void messageReceived(java.io.Serializable msg, Member sender)Description copied from interface:ChannelListenerReceive a message from the channel- Specified by:
- messageReceivedin interface- ChannelListener
- Parameters:
- msg- Serializable
- sender- - the source of the message
 
 - 
acceptpublic 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 interface- ChannelListener
- Parameters:
- msg- Serializable
- sender- Member
- Returns:
- boolean
 
 
- 
 
-