com.marklogic.hub.impl

Class HubProjectImpl

java.lang.Object

com.marklogic.hub.impl.HubProjectImpl

All Implemented Interfaces:

HubProject

public class HubProjectImpl
extends java.lang.Object
implements HubProject

Class for creating a hub Project

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENTITY_CONFIG_DIR
protected org.slf4j.Logger	logger

Fields inherited from interface com.marklogic.hub.HubProject

HUB_CONFIG_DIR, USER_CONFIG_DIR

Constructor Summary

Constructors

Constructor and Description
HubProjectImpl(java.lang.String projectDirStr)

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	getEntityConfigDir() Gets the path for the user server's directory
java.nio.file.Path	getEntityDatabaseDir() Gets the path for the entity database directory
java.nio.file.Path	getHubConfigDir() Gets the path for the hub's entities directory
java.nio.file.Path	getHubDatabaseDir() Gets the path for the hub's config directory
java.nio.file.Path	getHubEntitiesDir() Gets the path for the hub plugins directory
java.nio.file.Path	getHubPluginsDir() Gets the path for the entity database directory
java.nio.file.Path	getHubSecurityDir() Gets the path for the hub servers directory
java.nio.file.Path	getHubServersDir() Gets the path for the hub's database directory
java.nio.file.Path	getUserConfigDir() Gets the path for the entity database directory
java.nio.file.Path	getUserDatabaseDir() Gets the path for the user security directory
java.nio.file.Path	getUserSchemasDir() Gets the path for the user schemas directory
java.nio.file.Path	getUserSecurityDir() Gets the path for the user config directory
java.nio.file.Path	getUserServersDir() Gets the path for the entity database directory
void	init(java.util.Map<java.lang.String,java.lang.String> customTokens) Initializes a directory as a hub project directory.
boolean	isInitialized() Checks if the project has been initialized or not

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.marklogic.hub.HubProject

create

Field Detail

ENTITY_CONFIG_DIR

public static final java.lang.String ENTITY_CONFIG_DIR

See Also:

Constant Field Values

logger

protected final org.slf4j.Logger logger

Constructor Detail

HubProjectImpl

public HubProjectImpl(java.lang.String projectDirStr)

Method Detail

getHubPluginsDir

public java.nio.file.Path getHubPluginsDir()

Description copied from interface: HubProject

Gets the path for the entity database directory

Specified by:

getHubPluginsDir in interface HubProject

Returns:

the path for the entity's database directory

getHubEntitiesDir

public java.nio.file.Path getHubEntitiesDir()

Description copied from interface: HubProject

Gets the path for the hub plugins directory

Specified by:

getHubEntitiesDir in interface HubProject

Returns:

the path for the hub plugins directory

getHubConfigDir

public java.nio.file.Path getHubConfigDir()

Description copied from interface: HubProject

Gets the path for the hub's entities directory

Specified by:

getHubConfigDir in interface HubProject

Returns:

the path for the hub's entities directory

getHubDatabaseDir

public java.nio.file.Path getHubDatabaseDir()

Description copied from interface: HubProject

Gets the path for the hub's config directory

Specified by:

getHubDatabaseDir in interface HubProject

Returns:

the path for the hub's config directory

getHubServersDir

public java.nio.file.Path getHubServersDir()

Description copied from interface: HubProject

Gets the path for the hub's database directory

Specified by:

getHubServersDir in interface HubProject

Returns:

the path for the hub's database directory

getHubSecurityDir

public java.nio.file.Path getHubSecurityDir()

Description copied from interface: HubProject

Gets the path for the hub servers directory

Specified by:

getHubSecurityDir in interface HubProject

Returns:

the path for the hub servers database directory

getUserConfigDir

public java.nio.file.Path getUserConfigDir()

Description copied from interface: HubProject

Gets the path for the entity database directory

Specified by:

getUserConfigDir in interface HubProject

Returns:

the path for the entity's database directory

getUserSecurityDir

public java.nio.file.Path getUserSecurityDir()

Description copied from interface: HubProject

Gets the path for the user config directory

Specified by:

getUserSecurityDir in interface HubProject

Returns:

the path for the user config directory

getUserDatabaseDir

public java.nio.file.Path getUserDatabaseDir()

Description copied from interface: HubProject

Gets the path for the user security directory

Specified by:

getUserDatabaseDir in interface HubProject

Returns:

the path for the user security directory

getUserSchemasDir

public java.nio.file.Path getUserSchemasDir()

Description copied from interface: HubProject

Gets the path for the user schemas directory

Specified by:

getUserSchemasDir in interface HubProject

Returns:

the path for the user schemas directory

getUserServersDir

public java.nio.file.Path getUserServersDir()

Description copied from interface: HubProject

Gets the path for the entity database directory

Specified by:

getUserServersDir in interface HubProject

Returns:

the path for the entity's database directory

getEntityConfigDir

public java.nio.file.Path getEntityConfigDir()

Description copied from interface: HubProject

Gets the path for the user server's directory

Specified by:

getEntityConfigDir in interface HubProject

Returns:

the path for the user server's directory

getEntityDatabaseDir

public java.nio.file.Path getEntityDatabaseDir()

Description copied from interface: HubProject

Gets the path for the entity database directory

Specified by:

getEntityDatabaseDir in interface HubProject

Returns:

the path for the entity's database directory

isInitialized

public boolean isInitialized()

Description copied from interface: HubProject

Checks if the project has been initialized or not

Specified by:

isInitialized in interface HubProject

Returns:

true if initialized, false if not

init

public void init(java.util.Map<java.lang.String,java.lang.String> customTokens)

Description copied from interface: HubProject

Initializes a directory as a hub project directory. This means putting certain files and folders in place.

Specified by:

init in interface HubProject

Parameters:

customTokens - - some custom tokens to start with