Package org.glassfish.api.admin
Interface AdminCommand
-
- All Known Subinterfaces:
DiagnosticDump
,UndoableCommand
- All Known Implementing Classes:
AbstractListCommand
,AbstractListCommandProxy
,AbstractLongListCommand
,AddInstanceToDeploymentGroupCommand
,AddLibraryCommand
,AddResources
,ApplyHttpLbChanges
,AsadminRecorderEnabled
,AttachCommand
,BaseGetConfigSourceConfigurationCommand
,BaseGetNotifierConfigurationCommand
,BaseSetConfigSourceConfigurationCommand
,BaseSetNotifierConfigurationCommand
,BootstrapSecureAdminCommand
,ChangeAdminPassword
,ChangeMasterBrokerCommand
,CleanJbatchRepository
,ClearCache
,CollectLogFiles
,ConfigureJMSCluster
,ConfigureLBWeightCommand
,ConfigureManagedJobs
,CopyConfig
,CopyConfigCommand
,CreateAdminObject
,CreateApplicationRefCommand
,CreateAuditModule
,CreateAuthRealm
,CreateConnectorConnectionPool
,CreateConnectorResource
,CreateConnectorSecurityMap
,CreateConnectorWorkSecurityMap
,CreateContextService
,CreateCustomResource
,CreateDockerContainerCommand
,CreateFileUser
,CreateHttp
,CreateHTTPHealthCheckerCommand
,CreateHTTPLBRefCommand
,CreateHttpListener
,CreateHTTPLoadBalancerCommand
,CreateHttpRedirect
,CreateIiopListener
,CreateInstanceCommand
,CreateJACCProvider
,CreateJavaMailResource
,CreateJdbcConnectionPool
,CreateJdbcResource
,CreateJMSDestination
,CreateJMSHost
,CreateJMSResource
,CreateJndiResource
,CreateJvmOptions
,CreateLifecycleModuleCommand
,CreateLoginModuleConfig
,CreateManagedExecutorService
,CreateManagedScheduledExecutorService
,CreateManagedThreadFactory
,CreateMessageSecurityProvider
,CreateModuleConfigCommand
,CreateNetworkListener
,CreateNodeConfigCommand
,CreateNodeDcom
,CreateNodeDockerCommand
,CreateNodeImplicitCommand
,CreateNodeSshCommand
,CreateNodeTempCommand
,CreatePasswordAlias
,CreateProfiler
,CreateProtocol
,CreateProtocolFilter
,CreateProtocolFinder
,CreateRemoteNodeCommand
,CreateResourceAdapterConfig
,CreateResourceRef
,CreateSecurityProvider
,CreateSecurityService
,CreateSsl
,CreateSystemProperties
,CreateThreadpool
,CreateTransport
,CreateVirtualServer
,DeleteAdminObject
,DeleteApplicationRefCommand
,DeleteAuditModule
,DeleteAuthRealm
,DeleteConfigCommand
,DeleteConfigProperty
,DeleteConnectorConnectionPool
,DeleteConnectorResource
,DeleteConnectorSecurityMap
,DeleteConnectorWorkSecurityMap
,DeleteContextService
,DeleteCustomResource
,DeleteDockerContainerCommand
,DeleteFileUser
,DeleteHttp
,DeleteHTTPHealthCheckerCommand
,DeleteHTTPLBRefCommand
,DeleteHttpListener
,DeleteHttpRedirect
,DeleteIiopListener
,DeleteInstanceCommand
,DeleteJaccProvider
,DeleteJavaMailResource
,DeleteJdbcConnectionPool
,DeleteJdbcResource
,DeleteJMSDestination
,DeleteJMSHost
,DeleteJMSResource
,DeleteJndiResource
,DeleteJvmOptions
,DeleteLifecycleModuleCommand
,DeleteLogLevel
,DeleteManagedExecutorService
,DeleteManagedScheduledExecutorService
,DeleteManagedThreadFactory
,DeleteMessageSecurityProvider
,DeleteModuleConfigCommand
,DeleteNetworkListener
,DeleteNodeConfigCommand
,DeleteNodeDcom
,DeleteNodeDockerCommand
,DeleteNodeRemoteCommand
,DeleteNodeSshCommand
,DeleteNodeTempCommand
,DeletePasswordAlias
,DeleteProfiler
,DeleteProtocol
,DeleteProtocolFilter
,DeleteProtocolFinder
,DeleteResourceAdapterConfig
,DeleteResourceRef
,DeleteSsl
,DeleteSystemProperty
,DeleteTempNodesCommand
,DeleteThreadpool
,DeleteTransport
,DeleteVirtualServer
,DeployCommand
,DeployDirCommand
,DeployRemoteArchiveCommand
,DisableAsadminRecorder
,DisableCommand
,DisableEjbInvokerCommand
,DisableHTTPLBApplicationCommand
,DisableHTTPLBServerCommand
,DisableMonitoring
,DisablePhoneHome
,DisableSecureAdminCommand
,DumpHK2Command
,EnableAsadminRecorder
,EnableCommand
,EnableEjbInvokerCommand
,EnableHTTPLBApplicationCommand
,EnableHTTPLBServerCommand
,EnableJMXMonitoringServiceOnDas
,EnableJMXMonitoringServiceOnInstance
,EnableMonitoring
,EnablePhoneHome
,EnableSecureAdminCommand
,ExampleConfigUpdateOnlyOnDAS
,ExampleDASCommandWithReplication
,ExampleInstanceCommand
,ExportHttpLbConfig
,ExportSyncBundle
,FlushConnectionPoolLocal
,FlushInstancesConnectionPool
,FlushJMSDestination
,FreezeTransactionService
,GenerateBashAutoCompletionCommand
,GenerateClientCommand
,GenerateDomainSchema
,GenerateJvmReportCommand
,GenericCreateCommand
,GenericDeleteCommand
,GenericListCommand
,GetActivationSpecClass
,GetActiveConfigCommand
,GetAdminAuditServiceConfiguration
,GetAdminObjectClassNames
,GetAdminObjectConfigProps
,GetAdminObjectInterfaceNames
,GetApplicationLaunchURLsCommand
,GetAsadminRecorderConfiguration
,GetAWSSecretsConfigSourceConfigurationCommand
,GetAzureSecretsConfigSourceConfigurationCommand
,GetBuiltInCustomResources
,GetCDIEventbusNotifierConfigurationCommand
,GetClientStubsCommand
,GetCommand
,GetConfigOrdinal
,GetConfigProperty
,GetConfigSecretsDirectory
,GetConnectionDefinitionNames
,GetConnectionDefinitionPropertiesAndDefaults
,GetConnectorConfigJavaBeans
,GetContextRootCommand
,GetDatabaseVendorNames
,GetDeploymentConfigurationsCommand
,GetDockerContainerIdCommand
,GetDynamoDBConfigSourceConfigurationCommand
,GetEjbInvokerConfigurationCommand
,GetEnvironmentWarningConfigurationCommand
,GetEventbusNotifierConfigurationCommand
,GetExampleServiceMessageCommand
,GetFaultToleranceConfigurationCommand
,GetGCPSecretsConfigSourceConfigurationCommand
,GetGroupNamesCommand
,GetHabitatInfo
,GetHashiCorpSecretsConfigSourceConfigurationCommand
,GetHazelcastConfiguration
,GetHealthCheckConfiguration
,GetHostAndPortCommand
,GetHttpListener
,GetJDBCConfigSourceConfiguration
,GetJdbcDriverClassNames
,GetJmsNotifierConfigurationCommand
,GetJmsPhysicalDestinationCommand
,GetJMXMonitoringConfiguration
,GetLDAPConfigSourceConfiguration
,GetLogNotifierConfiguration
,GetMCFConfigProperties
,GetMessageListenerConfigProperties
,GetMessageListenerConfigPropertyTypes
,GetMessageListenerTypes
,GetMetricsConfigurationCommand
,GetMonitoringConfiguration
,GetMonitoringLevel
,GetMonitoringServiceConfiguration
,GetMPHealthCheckConfiguration
,GetNotificationConfigurationCommand
,GetOpenApiConfigurationCommand
,GetPayaraExecutorServiceConfigurationCommand
,GetPayloadCommand
,GetProtocol
,GetRelativeJWSURICommand
,GetRequestTracingConfiguration
,GetResourceAdapterConfigProperties
,GetRestartRequiredCommand
,GetRestConfig
,GetRestMonitoringConfiguration
,GetSystemRarsAllowingPoolCreation
,GetTargetsCommand
,GetTokensCommand
,GetTranslatedConfigValue
,GetValidationClassNames
,GetValidationTableNames
,HealthCheckBootstrapper
,HealthCheckConfigurer
,HealthCheckRebooter
,HealthCheckServiceConfigureCheckerWithThresholdsCommand
,HealthCheckServiceConfigurer
,HealthCheckServiceLister
,HealthCheckServiceThresholdConfigurer
,HoggingThreadsConfigurer
,InitializeAllApplicationsCommand
,InstanceDeployCommand
,InstanceGetLogFileCommand
,InstanceLifecycleModuleCommand
,InstanceRegisterInstanceCommand
,InstanceValidateRemoteDirDeploymentCommand
,IsAnonymousUserEnabledCommand
,IsSnifferUserVisibleCommand
,JMSPing
,LDAPAdminAccessConfigurator
,ListAdminObjects
,ListApplicationRefsCommand
,ListApplicationsCommand
,ListAppRefsCommand
,ListAuditModule
,ListAuthRealm
,ListBatchJobExecutions
,ListBatchJobExecutionsProxy
,ListBatchJobs
,ListBatchJobsProxy
,ListBatchJobSteps
,ListBatchJobStepsProxy
,ListBatchRuntimeConfiguration
,ListCacheKeys
,ListCaches
,ListClustersCommand
,ListCommand
,ListCommandDescriptorsCommand
,ListCommandsCommand
,ListComponentsCommand
,ListConfigsCommand
,ListConnectorConnectionPools
,ListConnectorResources
,ListConnectorSecurityMaps
,ListConnectorWorkSecurityMaps
,ListContainersCommand
,ListContextServices
,ListCustomResources
,ListDeploymentGroupsCommand
,ListFileGroup
,ListFileUser
,ListHazelcastClusterMembersCommand
,ListHazelcastMembers
,ListHealthCheckServices
,ListHistoricHealthChecks
,ListHttpListeners
,ListIiopListeners
,ListInstancesCommand
,ListJaccProviders
,ListJavaMailResources
,ListJdbcConnectionPools
,ListJdbcResources
,ListJMSDestinations
,ListJMSHosts
,ListJMSResources
,ListJndiEntries
,ListJndiResources
,ListJobsCommand
,ListJvmOptions
,ListLBConfigsCommand
,ListLibrariesCommand
,ListLifecycleModulesCommand
,ListLogAttributes
,ListLoggerLevels
,ListLoggers
,ListManagedExecutorServices
,ListManagedScheduledExecutorServices
,ListManagedThreadFactories
,ListMessageSecurityProvider
,ListModulesCommand
,ListNetworkListeners
,ListNodesCommand
,ListNodesConfigCommand
,ListNodesDcomCommand
,ListNodesDockerCommand
,ListNodesSshCommand
,ListPasswordAlias
,ListPersistenceTypesCommand
,ListPhoneHome
,ListProtocolFilters
,ListProtocolFinders
,ListProtocols
,ListRequestTraces
,ListResourceAdapterConfigs
,ListResourceRefs
,ListResources
,ListRestEndpointsCommand
,ListSubComponentsCommand
,ListSupportedCipherSuites
,ListSystemProperties
,ListThreadpools
,ListTimers
,ListTransports
,ListVirtualServers
,ListWebContextParamCommand
,ListWebEnvEntryCommand
,ListWebServicesCommand
,LoadDefaultLogAttributes
,LoadDefaultLogLevels
,LocationsCommand
,MigrateTimers
,Monitor
,MonitoringBootstrapper
,MTDeployCommand
,MTProvisionCommand
,MTUndeployCommand
,MTUnprovisionCommand
,NotificationConfigurer
,NotifierServiceLister
,OSGiShellCommand
,PingConnectionPool
,PingNodeDcomCommand
,PingNodeRemoteCommand
,PingNodeSshCommand
,PostDeployCommand
,PostDisableCommand
,PostEnableCommand
,PostRegisterInstanceCommand
,PostStateCommand
,PostUndeployCommand
,PostUnregisterInstanceCommand
,PredefinedAuthRealmClassNamesCommand
,PurgeJbatchRepository
,RecoverTransactions
,RecoverTransactionsInternal
,ReDeployCommand
,RemoveInstanceFromDeploymentGroupCommand
,RemoveLibraryCommand
,RequestTracingBootstrapper
,RestartClusterCommand
,RestartDeploymentGroupCommand
,RestartDomainCommand
,RestartHazelcast
,RestartHttpListenersCommand
,RestartInstanceCommand
,RestartInstanceInstanceCommand
,RestartMonitoring
,RollbackTransaction
,RotateLog
,RuntimeInfo
,SecureAdminCommand
,SendAsadminCommand
,SetAdminAuditConfiguration
,SetAmxEnabled
,SetAsadminRecorderConfiguration
,SetAWSSecretsConfigSourceConfigurationCommand
,SetAzureSecretsConfigSourceConfigurationCommand
,SetBatchRuntimeConfiguration
,SetCDIEventbusNotifierConfigurationCommand
,SetCommand
,SetConfigCacheDuration
,SetConfigOrdinal
,SetConfigProperty
,SetConfigSecretsDirectory
,SetDockerContainerIdCommand
,SetDynamoDBConfigSourceConfigurationCommand
,SetEjbInvokerConfigurationCommand
,SetEnvironmentWarningConfigurationCommand
,SetEventbusNotifierConfigurationCommand
,SetExampleServiceMessage
,SetFaultToleranceConfigurationCommand
,SetGCPSecretsConfigSourceConfigurationCommand
,SetHashiCorpSecretsConfigSourceConfigurationCommand
,SetHazelcastConfiguration
,SetHealthCheckConfiguration
,SetHealthCheckServiceConfiguration
,SetJDBCConfigSourceConfiguration
,SetJmsNotifierConfigurationCommand
,SetJMXMonitoringConfiguration
,SetLDAPConfigSourceConfiguration
,SetLogAttributes
,SetLogFileFormat
,SetLogLevel
,SetLogNotifierConfiguration
,SetMetricsConfigurationCommand
,SetMicroProfileHealthCheckerConfiguration
,SetMonitoringConfiguration
,SetMonitoringConsoleConfigurationCommand
,SetMonitoringLevel
,SetMonitoringServiceConfiguration
,SetMPHealthCheckConfiguration
,SetNetworkListenerConfiguration
,SetNotificationConfiguration
,SetOpenApiConfigurationCommand
,SetPayaraExecutorServiceConfigurationCommand
,SetRequestTracingConfiguration
,SetRestConfig
,SetRestMonitoringConfigurationCommand
,SetSecureMicroprofileConfigurationCommand
,SetupSshCommand
,SetWebContextParamCommand
,SetWebEnvEntryCommand
,ShowComponentStatusCommand
,StartClusterCommand
,StartDeploymentGroupCommand
,StartDockerContainerCommand
,StartInstanceCommand
,StopClusterCommand
,StopDeploymentGroupCommand
,StopDockerContainerCommand
,StopDomainCommand
,StopInstanceCommand
,StopInstanceInstanceCommand
,StuckThreadsConfigurer
,SupportsUserManagementCommand
,SynchronizeFiles
,SynchronizeRealmFromConfig
,TestNotifier
,UndeployCommand
,UnFreezeTransactionService
,UnsetWebContextParamCommand
,UnsetWebEnvEntryCommand
,UpdateApplicationRefCommand
,UpdateConnectorSecurityMap
,UpdateConnectorWorkSecurityMap
,UpdateFileUser
,UpdateJmsPhysicalDestinationCommand
,UpdateNodeCommand
,UpdateNodeConfigCommand
,UpdateNodeDcomCommand
,UpdateNodeDockerCommand
,UpdateNodeRemoteCommand
,UpdateNodeSshCommand
,UpdatePasswordAlias
,UpdateResourceRef
,UptimeCommand
,ValidateDcom
,ValidateNodeCommand
,ValidateRemoteDirDeploymentCommand
,VersionCommand
,WebEnvEntryCommand
,WebModuleConfigCommand
,WrappedAdminCommand
@Contract public interface AdminCommand
This is an admin command interface, command implementations have to be stateless and should also have a
Command implementations should use theorg.jvnet.hk2.component.Scope
value ofPerLookup
Param
annotation to annotate the command parameters. Command implementations are normal services and are therefore following the normal hk2 service lifecycle and injection features.Internationalization can be provided by using the
By default, if anI18n
} annotation. Each parameter declaration can also be annotated with anI18n
annotation to point to the parameter .I18n
is used to annotate implementations, the value of the annotation will be used as follow to lookup strings in the module's local strings properties files. key provide a short description of the command role and expected output key.usagetext [optional] if not provided, usage text will be calculated based on parameters declaration key.paramName [optional] provide a description for the parameter "paramName", it can be overriden by annotating the @Param annotated field/method with aI18n
- Author:
- Jerome Dochez
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
execute(AdminCommandContext context)
Executes the command with the command parameters passed as Properties where the keys are the parameter names and the values are the parameter values
-
-
-
Method Detail
-
execute
void execute(AdminCommandContext context)
Executes the command with the command parameters passed as Properties where the keys are the parameter names and the values are the parameter values- Parameters:
context
- information
-
-