com.sun.enterprise.util.io
Class ServerDirs

java.lang.Object
  com.sun.enterprise.util.io.ServerDirs

public class ServerDirs
extends java.lang.Object

The hierarchy of directories above a running DAS or server instance can get messy to deal with -- thus this class. This class is a bullet-proof holder of that information. Instances and DAS are arranged differently: examples: DAS domainDir = getServerDir() == C:/glassfish3/glassfish/domains/domain1 domainsDir = getServerParentDir() == C:/glassfish3/glassfish/domains grandparent-dir is meaningless Instance instanceDir = getServerDir() == C:/glassfish3/glassfish/nodes/mymachine/instance1 agentDir = getServerParentDir() == C:/glassfish3/glassfish/nodes/mymachine agentsDir = getServerGrandParentDir() == C:/glassfish3/glassfish/nodes Currently in all cases the name of the serverDir is the name of the server -- by our definition. THIS CLASS IS GUARANTEED THREAD SAFE THIS CLASS IS GUARANTEED IMMUTABLE Contract: Caller is supposed to NOT call methods on an instance of this class. It's "advanced java" to be able to do that anyway. I don't allow half-baked data out. It's all or none. The "valid" flag is checked and if invalid -- all methods return null. They don't throw an Exception because the caller is not supposed to call the methods - it would just annoy the caller.

Since:

3.1 Created: April 19, 2010

Author:

Byron Nevins

Constructor Summary

ServerDirs()

ServerDirs(java.io.File leaf)

Method Summary

java.lang.String	deletePidFile() Return a message suitable for printing, not just for errors.
java.io.File	getAgentDir()
java.io.File	getConfigDir()
java.io.File	getDasPropertiesFile()
java.io.File	getDomainXml()
java.lang.String	getLocalPassword()
java.io.File	getLocalPasswordFile()
java.io.File	getPidFile()
java.io.File	getServerDir()
java.io.File	getServerGrandParentDir()
java.lang.String	getServerName()
java.io.File	getServerParentDir()
boolean	isValid()
ServerDirs	refresh()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ServerDirs

public ServerDirs()

ServerDirs

public ServerDirs(java.io.File leaf)
           throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getServerName

public final java.lang.String getServerName()

deletePidFile

public final java.lang.String deletePidFile()

Return a message suitable for printing, not just for errors.

Returns:

refresh

public ServerDirs refresh()
                   throws java.io.IOException

Throws:

java.io.IOException

getServerDir

public final java.io.File getServerDir()

getAgentDir

public final java.io.File getAgentDir()

getServerParentDir

public final java.io.File getServerParentDir()

getServerGrandParentDir

public final java.io.File getServerGrandParentDir()

getDomainXml

public final java.io.File getDomainXml()

getConfigDir

public final java.io.File getConfigDir()

getPidFile

public final java.io.File getPidFile()

getDasPropertiesFile

public final java.io.File getDasPropertiesFile()

getLocalPassword

public java.lang.String getLocalPassword()

getLocalPasswordFile

public final java.io.File getLocalPasswordFile()

isValid

public final boolean isValid()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object