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
A 
 
MembershipService that 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 the membershipProviderClassName property.
 Possible shortcuts are kubernetes and dns. For dns look at the DNSMembershipProvider.
 
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 SummaryFieldsModifier and TypeFieldDescriptionprotected static final byte[]static final Stringprotected static final StringManagerFields inherited from class org.apache.catalina.tribes.membership.MembershipServiceBasechannel, listener, propertiesFields inherited from interface org.apache.catalina.tribes.MembershipServiceMBR_RX, MBR_TX
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionintlonggetLocalMember(boolean incAliveTime) Get the local member.Get the MembershipProviderReturn the membership provider class.getProperty(String name) Return a property.intvoidsetConnectTimeout(int connectTimeout) voidsetDomain(byte[] domain) voidsetExpirationTime(long expirationTime) voidsetLocalMemberProperties(String listenHost, int listenPort, int securePort, int udpPort) Sets the local member properties for broadcasting.voidsetMembershipProvider(MembershipProvider memberProvider) voidsetMembershipProviderClassName(String membershipProviderClassName) Set the membership provider class.voidsetPayload(byte[] payload) Set a payload to be broadcasted with each membership broadcast.booleansetProperty(String name, 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, startMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.catalina.tribes.membership.cloud.CloudMembershipServiceMBeanfindMemberByName, getMembersByName, getProperties, hasMembers
- 
Field Details- 
sm
- 
MEMBERSHIP_PROVIDER_CLASS_NAME- See Also:
 
- 
INITIAL_IDprotected static final byte[] INITIAL_ID
 
- 
- 
Constructor Details- 
CloudMembershipServicepublic CloudMembershipService()
 
- 
- 
Method Details- 
getPropertyReturn a property.- Parameters:
- name- the property name
- Returns:
- the property value
 
- 
setPropertySet a property.- Parameters:
- name- the property name
- value- the property value
- Returns:
- trueif the property was successfully set
 
- 
getMembershipProviderClassNameReturn the membership provider class.- Returns:
- the classname
 
- 
setMembershipProviderClassNameSet the membership provider class.- Parameters:
- membershipProviderClassName- the class name
 
- 
startDescription 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:
- Exception- if the service fails to start.
- 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
 
- 
getLocalMemberDescription 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(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
 
- 
getMembershipProviderDescription copied from interface:MembershipServiceGet the MembershipProvider- Specified by:
- getMembershipProviderin interface- MembershipService
- Returns:
- MembershipProvider
 
- 
setMembershipProvider
- 
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) 
 
-