com.atlassian.jira.cluster
Interface ClusterNodeProperties

All Known Implementing Classes:
ClusterNodePropertiesImpl

public interface ClusterNodeProperties

This is used to lookup cluster properties from the underlying properties file.

Since:
v6.1

Method Summary
 String getNodeId()
          Get the node id for a clustered or HA installation.
 String getProperty(String key)
           
 String getSharedHome()
          Get the shared home for a clustered or HA installation.
 boolean isValid()
          whether the underlying cluster.properties file is valid or not
 boolean propertyFileExists()
          The cluster.properties file is optional.
 void refresh()
          Called to reload the cluster properties.
 

Method Detail

getProperty

@Nullable
String getProperty(String key)
Parameters:
key - key for the property you want to look up
Returns:
String value of the property, null if it does not exist

getSharedHome

String getSharedHome()
Get the shared home for a clustered or HA installation. Will return null if no shared home is set.

Returns:

getNodeId

String getNodeId()
Get the node id for a clustered or HA installation. Will return null if no node id is set.

Returns:

refresh

void refresh()
Called to reload the cluster properties.


propertyFileExists

boolean propertyFileExists()
The cluster.properties file is optional. If it exists then JIRA is assumed to be in a cluster

Returns:

isValid

boolean isValid()
whether the underlying cluster.properties file is valid or not

Returns:


Copyright © 2002-2014 Atlassian. All Rights Reserved.