FileDocCategorySizeDatePackage
DomainsManager.javaAPI DocGlassfish v2 API5831Fri May 04 22:24:30 BST 2007com.sun.enterprise.admin.servermgmt

DomainsManager

public interface DomainsManager

Fields Summary
Constructors Summary
Methods Summary
public voidchangeMasterPassword(DomainConfig domainConfig)
Changes the master password for the domain

public voidcreateDomain(DomainConfig domainConfig)
Creates a domain

param
domainConfig The configuration params that are required to create the domain. (eg :- domain admin port, http port, default locale, domain root, install root etc.) The relevant keys are defined in DomainConfig. The implementors of this class should validate the values that are supplied.
throws
DomainException This exception is thrown if - the domain already exists. - an invalid or insufficient config. is supplied. - an exception occurred during domain creation.

public voiddeleteDomain(DomainConfig domainConfig)
Deletes a domain identified by the given name. (Should we stop the DAS and instances administered by this domain before deleting the domain?)

param
domainConfig
throws
DomainException This exception is thrown if
    - the domain doesnot exist. - an exception occurred while deleting the domain.

public java.util.BitSetgetDomainFlags()
In SE/EE we need an admin user/password that the DAS can use to authenticate to Node Agents and servers in the domain. This is not the case in PE; hence this flag -- DomainConfig.K_FLAG_START_DOMAIN_NEEDS_ADMIN_USER In SE/EE we need an extra non secure http port to host the Lockhart components which is controlled by -- DomainConfig.K_FLAG_CREATE_DOMAIN_NEEDS_ALTERNATE_ADMIN_PORT

return
flags toggling SE/EE specific behavior.

public java.lang.String[]getExtraPasswordOptions(DomainConfig config)
SE/EE supports NSS as its native SSL database. NSS is capable of supporting multiple slots (e.g. for different SSL hardware devices, smartcards, etc). Each device needs a specific password which the CLI must prompt for.

public InstancesManagergetInstancesManager(RepositoryConfig config)

public java.lang.String[]listDomains(DomainConfig domainConfig)
Lists all the domains.

public java.lang.String[]listDomainsAndStatus(DomainConfig domainConfig)
Lists all the domains and their status

public voidstartDomain(DomainConfig domainConfig)
Starts the Domain Administration Server (DAS) that administers the given domain.

param
startParams
throws
DomainException

public voidstopDomain(DomainConfig domainConfig)
Stops the Domain Administration Server (DAS) that administers the given domain.

param
domainConfig
throws
DomainException

public voidstopDomainForcibly(DomainConfig domainConfig, int timeout)
Stops the Domain Administration Server (DAS) that administers the given domain.

param
domainConfig
throws
DomainException

public voidvalidateAdminUserAndPassword(DomainConfig domainConfig)

public voidvalidateDomain(DomainConfig domainConfig, boolean domainExists)

public voidvalidateMasterPassword(DomainConfig config)