com.marklogic.hub

Interface InstallInfo

All Known Implementing Classes:

InstallInfoImpl

public interface InstallInfo

Stores and reports information from MarkLogic server about the installed status of the DHF This interface abstracts holding state. It does not make any calls itself.

Method Summary

Modifier and Type	Method and Description
boolean	areForestsExistent(com.marklogic.hub.DatabaseKind kind) Checks to see if the forests are present and accessible
static InstallInfo	create() Creates and returns an installinfo object
boolean	isAppServerExistent(com.marklogic.hub.DatabaseKind kind) Checks to see if the App Server is present and accessible
boolean	isCollectionLexiconOn(com.marklogic.hub.DatabaseKind kind) Checks to see if the lexicon collection is set and on
boolean	isDbExistent(com.marklogic.hub.DatabaseKind kind) Checks to see if the Database is present and accessible
boolean	isInstalled() Checks if DHF has been installed
boolean	isPartiallyInstalled() Returns if an install has been performed, but not complete
boolean	isTripleIndexOn(com.marklogic.hub.DatabaseKind kind) Checks to see if the triple index is set and on
void	setAppServerExistent(com.marklogic.hub.DatabaseKind kind, boolean stagingAppServerExists) Sets the boolean property if the app server exists for the databasekind
void	setCollectionLexiconOn(com.marklogic.hub.DatabaseKind kind, boolean stagingCollectionLexiconOn) Sets if the collection lexicon is on or not
void	setDbExistent(com.marklogic.hub.DatabaseKind kind, boolean stagingDbExists) Sets the boolean property if the database exists for the databasekind
void	setForestsExistent(com.marklogic.hub.DatabaseKind kind, boolean stagingForestsExist) Sets the boolean property if the forests exist for the databasekind
void	setTripleIndexOn(com.marklogic.hub.DatabaseKind kind, boolean stagingTripleIndexOn) Sets if the triple index is on or off by boolean
java.lang.String	toString() Returns the entire object as a string

Method Detail

create

static InstallInfo create()

Creates and returns an installinfo object

Returns:

InstallInfo object

isPartiallyInstalled

boolean isPartiallyInstalled()

Returns if an install has been performed, but not complete

Returns:

true if partially installed, false if not installed

isInstalled

boolean isInstalled()

Checks if DHF has been installed

Returns:

true if installed, false if not

toString

java.lang.String toString()

Returns the entire object as a string

Overrides:

toString in class java.lang.Object

Returns:

a string version the object

isAppServerExistent

boolean isAppServerExistent(com.marklogic.hub.DatabaseKind kind)

Checks to see if the App Server is present and accessible

Parameters:

kind - - DatabaseKind enum, eg: STAGING or JOB

Returns:

true if present, false if not found

setAppServerExistent

void setAppServerExistent(com.marklogic.hub.DatabaseKind kind,
                          boolean stagingAppServerExists)

Sets the boolean property if the app server exists for the databasekind

Parameters:

kind - - DatabaseKind enum, eg: STAGING or JOB

stagingAppServerExists - - true if it exists, false if it doesn't

isDbExistent

boolean isDbExistent(com.marklogic.hub.DatabaseKind kind)

Checks to see if the Database is present and accessible

Parameters:

kind - - DatabaseKind enum, eg: STAGING or JOB

Returns:

true if present, false if not found

setDbExistent

void setDbExistent(com.marklogic.hub.DatabaseKind kind,
                   boolean stagingDbExists)

Sets the boolean property if the database exists for the databasekind

Parameters:

kind - - DatabaseKind enum, eg: STAGING or JOB

stagingDbExists - - true if it exists, false if it doesn't

isTripleIndexOn

boolean isTripleIndexOn(com.marklogic.hub.DatabaseKind kind)

Checks to see if the triple index is set and on

Parameters:

kind - - DatabaseKind enum, eg: STAGING or JOB

Returns:

true if present and enabled, false if not

setTripleIndexOn

void setTripleIndexOn(com.marklogic.hub.DatabaseKind kind,
                      boolean stagingTripleIndexOn)

Sets if the triple index is on or off by boolean

Parameters:

kind - - DatabaseKind enum, eg: STAGING or JOB

stagingTripleIndexOn - - true if the triple index is on, false if it is not

isCollectionLexiconOn

boolean isCollectionLexiconOn(com.marklogic.hub.DatabaseKind kind)

Checks to see if the lexicon collection is set and on

Parameters:

kind - - DatabaseKind enum, eg: STAGING or JOB

Returns:

true if present and enabled, false if not

setCollectionLexiconOn

void setCollectionLexiconOn(com.marklogic.hub.DatabaseKind kind,
                            boolean stagingCollectionLexiconOn)

Sets if the collection lexicon is on or not

Parameters:

kind - - DatabaseKind enum, eg: STAGING or JOB

stagingCollectionLexiconOn - - true if it's on, false if it's not

areForestsExistent

boolean areForestsExistent(com.marklogic.hub.DatabaseKind kind)

Checks to see if the forests are present and accessible

Parameters:

kind - - DatabaseKind enum, eg: STAGING or JOB

Returns:

true if present, false if not found

setForestsExistent

void setForestsExistent(com.marklogic.hub.DatabaseKind kind,
                        boolean stagingForestsExist)

Sets the boolean property if the forests exist for the databasekind

Parameters:

kind - - DatabaseKind enum, eg: STAGING or JOB

stagingForestsExist - - true if it exists, false if it doesn't