Class CloudMembershipService
- java.lang.Object
- 
- org.apache.catalina.tribes.membership.MembershipServiceBase
- 
- org.apache.catalina.tribes.membership.cloud.CloudMembershipService
 
 
- 
- All Implemented Interfaces:
- CloudMembershipServiceMBean,- MembershipListener,- MembershipService
 
 public class CloudMembershipService extends MembershipServiceBase implements CloudMembershipServiceMBean AMembershipServicethat uses Kubernetes API(default) or DNS to retrieve the members of a cluster.
 The default implementation of the MembershipProvider component is the KubernetesMembershipProvider. The MembershipProvider can be configured by themembershipProviderClassNameproperty. Possible shortcuts arekubernetesanddns. For dns look at theDNSMembershipProvider.Configuration example server.xml<Server ... <Service ... <Engine ... <Host ... <Cluster className="org.apache.catalina.ha.tcp.SimpleTcpCluster"> <Channel className="org.apache.catalina.tribes.group.GroupChannel"> <Membership className="org.apache.catalina.tribes.membership.cloud.CloudMembershipService"/> </Channel> </Cluster> ...
- 
- 
Field SummaryFields Modifier and Type Field Description protected static byte[]INITIAL_IDstatic java.lang.StringMEMBERSHIP_PROVIDER_CLASS_NAMEprotected static StringManagersm- 
Fields inherited from class org.apache.catalina.tribes.membership.MembershipServiceBasechannel, listener, properties
 - 
Fields inherited from interface org.apache.catalina.tribes.MembershipServiceMBR_RX, MBR_TX
 
- 
 - 
Constructor SummaryConstructors Constructor Description CloudMembershipService()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetConnectTimeout()longgetExpirationTime()MembergetLocalMember(boolean incAliveTime)Get the local member.MembershipProvidergetMembershipProvider()Get the MembershipProviderjava.lang.StringgetMembershipProviderClassName()Return the membership provider class.java.lang.ObjectgetProperty(java.lang.String name)Return a property.intgetReadTimeout()voidsetConnectTimeout(int connectTimeout)voidsetDomain(byte[] domain)voidsetExpirationTime(long expirationTime)voidsetLocalMemberProperties(java.lang.String listenHost, int listenPort, int securePort, int udpPort)Sets the local member properties for broadcasting.voidsetMembershipProvider(MembershipProvider memberProvider)voidsetMembershipProviderClassName(java.lang.String membershipProviderClassName)Set the membership provider class.voidsetPayload(byte[] payload)Set a payload to be broadcasted with each membership broadcast.booleansetProperty(java.lang.String name, java.lang.String value)Set a property.voidsetReadTimeout(int readTimeout)voidstart(int level)Starts the membership service.voidstop(int level)Starts the membership service.- 
Methods inherited from class org.apache.catalina.tribes.membership.MembershipServiceBasebroadcast, findMemberByName, getChannel, getMember, getMembers, getMembersByName, getProperties, hasMembers, memberAdded, memberDisappeared, removeMembershipListener, setChannel, setMembershipListener, setProperties, start
 - 
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.membership.cloud.CloudMembershipServiceMBeanfindMemberByName, getMembersByName, getProperties, hasMembers
 
- 
 
- 
- 
- 
Field Detail- 
smprotected static final StringManager sm 
 - 
MEMBERSHIP_PROVIDER_CLASS_NAMEpublic static final java.lang.String MEMBERSHIP_PROVIDER_CLASS_NAME - See Also:
- Constant Field Values
 
 - 
INITIAL_IDprotected static final byte[] INITIAL_ID 
 
- 
 - 
Method Detail- 
getPropertypublic java.lang.Object getProperty(java.lang.String name) Return a property.- Parameters:
- name- the property name
- Returns:
- the property value
 
 - 
setPropertypublic boolean setProperty(java.lang.String name, java.lang.String value)Set a property.- Parameters:
- name- the property name
- value- the property value
- Returns:
- trueif the property was successfully set
 
 - 
getMembershipProviderClassNamepublic java.lang.String getMembershipProviderClassName() Return the membership provider class.- Returns:
- the classname
 
 - 
setMembershipProviderClassNamepublic void setMembershipProviderClassName(java.lang.String membershipProviderClassName) Set the membership provider class.- Parameters:
- membershipProviderClassName- the class name
 
 - 
startpublic void start(int level) throws java.lang.ExceptionDescription copied from interface:MembershipServiceStarts the membership service. If a membership listeners is added the listener will start to receive membership events.- Specified by:
- startin interface- MembershipService
- Parameters:
- level- - level MBR_RX starts listening for members, level MBR_TX starts broad casting the server
- Throws:
- java.lang.Exception- if the service fails to start.
- java.lang.IllegalArgumentException- if the level is incorrect.
 
 - 
stoppublic void stop(int level) Description copied from interface:MembershipServiceStarts the membership service. If a membership listeners is added the listener will start to receive membership events.- Specified by:
- stopin interface- MembershipService
- Parameters:
- level- - level MBR_RX stops listening for members, level MBR_TX stops broad casting the server
 
 - 
getLocalMemberpublic Member getLocalMember(boolean incAliveTime) Description copied from interface:MembershipServiceGet the local member.- Specified by:
- getLocalMemberin interface- MembershipService
- Parameters:
- incAliveTime-- trueto set the alive time on the local member
- Returns:
- the member object that defines this member
 
 - 
setLocalMemberPropertiespublic void setLocalMemberProperties(java.lang.String listenHost, int listenPort, int securePort, int udpPort)Description copied from interface:MembershipServiceSets the local member properties for broadcasting.- Specified by:
- setLocalMemberPropertiesin interface- MembershipService
- Parameters:
- listenHost- Listen to host
- listenPort- Listen to port
- securePort- Use a secure port
- udpPort- Use UDP
 
 - 
setPayloadpublic void setPayload(byte[] payload) Description copied from interface:MembershipServiceSet a payload to be broadcasted with each membership broadcast.- Specified by:
- setPayloadin interface- MembershipService
- Parameters:
- payload- byte[]
 
 - 
setDomainpublic void setDomain(byte[] domain) - Specified by:
- setDomainin interface- MembershipService
 
 - 
getMembershipProviderpublic MembershipProvider getMembershipProvider() Description copied from interface:MembershipServiceGet the MembershipProvider- Specified by:
- getMembershipProviderin interface- MembershipService
- Returns:
- MembershipProvider
 
 - 
setMembershipProviderpublic void setMembershipProvider(MembershipProvider memberProvider) 
 - 
getConnectTimeoutpublic int getConnectTimeout() - Specified by:
- getConnectTimeoutin interface- CloudMembershipServiceMBean
 
 - 
setConnectTimeoutpublic void setConnectTimeout(int connectTimeout) 
 - 
getReadTimeoutpublic int getReadTimeout() - Specified by:
- getReadTimeoutin interface- CloudMembershipServiceMBean
 
 - 
setReadTimeoutpublic void setReadTimeout(int readTimeout) 
 - 
getExpirationTimepublic long getExpirationTime() - Specified by:
- getExpirationTimein interface- CloudMembershipServiceMBean
 
 - 
setExpirationTimepublic void setExpirationTime(long expirationTime) 
 
- 
 
-