|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jscape.inet.mft.management.client.api.ManagerSubsystem
public final class ManagerSubsystem
Management system facade. Contains methods to manage the Secure FTP Server including creating, starting and stopping domains, creating user accounts and groups.
The following is a little example that shows how can the API be used
// creates a new ManagerSubsystem instance passing as argument a ClientSessionContext ManagerSubsystem manager = new ManagerSubsystem(context); try{ // connects to the Secure FTP Server manager.connect(); // Creates a new VirtualLocalFile which is used as argument when the new account will be created VirtualLocalFile[] paths = new VirtualLocalFile[1]; // Creates a VirtualLocalFile AccessPermissions permissions = new AccessPermissions(); // Permission of the virtual file name paths[0] = new VirtualLocalFile(virtualFileName, permissions, realFileName); //A new account instance is created Account account = new Account(userName, login, password, paths, null); // The account is added to the Server "server" manager.addAccount("server", account); } catch(Exception e){ e.printStackTrace(); } finally{ managerServer.disconnect(); }
Constructor Summary | |
---|---|
ManagerSubsystem(ManagerConfiguration configuration)
Creates a manager subsystem instance |
|
ManagerSubsystem(java.lang.String configFile)
Creates a new manager subsystem instance. |
Method Summary | |
---|---|
void |
addAccount(java.lang.String domainName,
Account account)
Adds a new account to the domain. |
void |
addDirectoryMonitor(java.lang.String domainName,
DirectoryMonitor monitor)
Adds a new directory monitor. |
void |
addDomain(DomainDescriptor descriptor)
Adds a new domain. |
void |
addGroup(java.lang.String domainName,
Group group)
Adds a new group. |
void |
addReport(java.lang.String domainName,
Report report)
Adds a new report to the domain. |
void |
addResource(java.lang.String domainName,
ResourceDescriptor resource)
Adds a new remote resource. |
void |
connect()
Connects to the remote server part. |
void |
deleteAccount(java.lang.String domaiName,
java.lang.String accountName)
Deletes domain account. |
void |
deleteDirectoryMonitor(java.lang.String domainName,
java.lang.String monitorName)
Removes directory monitor. |
void |
deleteDomain(java.lang.String name)
Deletes a domain. |
void |
deleteGroup(java.lang.String domainName,
java.lang.String groupName)
Deletes a group. |
void |
deleteReport(java.lang.String domainName,
java.lang.String reportName)
Deletes a report. |
void |
deleteResource(java.lang.String domainName,
java.lang.String resourceName)
Deletes a resource. |
void |
disconnect()
Disconnects from the remote server. |
void |
executeRequest(com.jscape.inet.mft.management.requests.ManagerRequest request)
Executes all the request operations in ManagerSubsystem API |
IPAccessRule[] |
getAccessRules(java.lang.String name)
Gets a domain IP access rules. |
Account[] |
getAccounts(java.lang.String domainName)
Gets domain accounts. |
DomainDescriptor[] |
getAllDomains()
Gets all available domains descriptors. |
CertificateMap |
getCertificates()
Gets known client certificates. |
ManagerConfiguration |
getConfiguration()
Reurns client context. |
com.jscape.util.event.CommonEventContext |
getContext()
Gets the context instance. |
DirectoryMonitor[] |
getDirectoryMonitors(java.lang.String domainName)
Returns directory monitors for the specifed domain. |
EmailServiceConfiguration |
getEmailServiceConfiguration()
Returns email service configuration. |
Group[] |
getGroups(java.lang.String domainName)
Gets domain groups. |
com.jscape.inet.mft.management.licensing.License |
getLicense()
Gets an application license data. |
java.lang.String |
getLog(java.lang.String name,
int recordsCount)
Gets the latest server log lines. |
ManagerConfiguration |
getManagerConfiguration()
Returns a current remote management server configuration. |
KeyPairMap |
getPrivateKeys()
Gets server keys. |
PublicKeyMap |
getPublicKeys()
Gets known client public keys. |
Report[] |
getReports(java.lang.String domainName)
Returns all domain reports. |
com.jscape.inet.mft.common.Statistics |
getStatistics(java.lang.String name)
Gets a domain statistics. |
WebConfiguration |
getWebConfiguration()
Returns web server configuration. |
boolean |
isConnected()
Checks if current instance is connected to the server. |
void |
kickUser(java.lang.String domainName,
java.lang.String accountName,
boolean disableAccount)
Closes user sessions. |
void |
setAccessRules(java.lang.String domainName,
IPAccessRule[] rules)
Sets domain IP access rules. |
void |
setAuthenticationService(java.lang.String domainName,
AuthenticationServiceDescriptor serviceDescriptor)
Sets new domain authentication service. |
void |
setConfiguration(ManagerConfiguration configuration)
Sets new client context. |
void |
setDatastoreService(java.lang.String domainName,
DatastoreServiceDescriptor serviceDescriptor)
Sets new domain datastore service. |
void |
setDomainDescription(java.lang.String domainName,
java.lang.String description)
Sets new domain description. |
void |
setEmailServiceConfiguration(EmailServiceConfiguration configuration,
java.util.Properties properties)
Sets email service configuration. |
void |
setEventService(java.lang.String domainName,
ServiceDescriptor serviceDescriptor)
Sets new domain event service. |
void |
setKeys(CertificateMap certificates,
PublicKeyMap publicKeys,
KeyPairMap serverKeys,
com.jscape.pgp.PgpKeystore pgpKeys)
Sets security credentials. |
void |
setLogService(java.lang.String domainName,
LogServiceDescriptor serviceDescriptor,
LogConfiguration configuration)
Sets new domain log service. |
void |
setManagerConfiguration(ManagerConfiguration configuration)
Sets a new management server configuration and restarts it. |
void |
setPasswordService(java.lang.String domainName,
PasswordServiceDescriptor serviceDescriptor)
Sets new domain password service. |
void |
setRestrictionServices(java.lang.String domainName,
ServiceDescriptor[] serviceDescriptors)
Sets new domain restriction services. |
void |
setTransportServices(java.lang.String domainName,
TransportServiceDescriptor[] serviceDescriptors,
Configuration[] configurations)
Sets new domain transport services. |
void |
setWebConfiguration(WebConfiguration configuration)
Sets web server configuration. |
void |
startAllDomains()
Starts all domains. |
void |
startDomain(java.lang.String name)
Starts a specified domain. |
void |
stopAllDomains()
Stops all domains. |
void |
stopDomain(java.lang.String name)
Stops a specified domain. |
void |
testAuthenticationService(ServiceDescriptor descriptor,
java.lang.String login,
java.lang.String password)
Tests authentication subsystem. |
void |
testDatastoreService(ServiceDescriptor descriptor)
Tests the datastore service. |
void |
testLogService(ServiceDescriptor descriptor)
Tests log service subsystem. |
void |
testResource(ResourceDescriptor resource)
Tests remote resurce accessibility. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ManagerSubsystem(java.lang.String configFile) throws ManagerException
configFile
- configuration file path
ManagerException
- if an error occurspublic ManagerSubsystem(ManagerConfiguration configuration) throws ManagerException
configuration
- configuration
ManagerException
- if an error occursMethod Detail |
---|
public ManagerConfiguration getConfiguration()
public void setConfiguration(ManagerConfiguration configuration)
configuration
- new contextpublic void connect() throws ManagerException
ManagerException
- if an error occurspublic void disconnect()
public boolean isConnected()
true
if instance is connectedpublic ManagerConfiguration getManagerConfiguration() throws ManagerException
ManagerException
- if an error occurspublic void setManagerConfiguration(ManagerConfiguration configuration) throws ManagerException
configuration
- new configuration
ManagerException
- if an error occurspublic WebConfiguration getWebConfiguration() throws ManagerException
ManagerException
- if an error occurspublic void setWebConfiguration(WebConfiguration configuration) throws ManagerException
configuration
- a new web server configuration
ManagerException
- if an error occurspublic EmailServiceConfiguration getEmailServiceConfiguration() throws ManagerException
ManagerException
- if an error occurspublic void setEmailServiceConfiguration(EmailServiceConfiguration configuration, java.util.Properties properties) throws ManagerException
configuration
- new configurationproperties
- email properties
ManagerException
- if an error occurspublic com.jscape.inet.mft.management.licensing.License getLicense() throws ManagerException
ManagerException
- if an error occurspublic CertificateMap getCertificates() throws ManagerException
ManagerException
- if an error occurspublic PublicKeyMap getPublicKeys() throws ManagerException
ManagerException
- if an error occurspublic KeyPairMap getPrivateKeys() throws ManagerException
ManagerException
- if an error occurspublic void setKeys(CertificateMap certificates, PublicKeyMap publicKeys, KeyPairMap serverKeys, com.jscape.pgp.PgpKeystore pgpKeys) throws ManagerException
certificates
- known client certificatespublicKeys
- known client public keysserverKeys
- server keyspgpKeys
- PGP keys
ManagerException
- if an error occurspublic DomainDescriptor[] getAllDomains() throws ManagerException
ManagerException
- if an error occurspublic void addDomain(DomainDescriptor descriptor) throws ManagerException
descriptor
- the domain descriptor
ManagerException
- if an error occurspublic void deleteDomain(java.lang.String name) throws ManagerException
name
- the domain name
ManagerException
- if an error occurspublic void setDomainDescription(java.lang.String domainName, java.lang.String description) throws ManagerException
domainName
- target domain namedescription
- new domain description
ManagerException
- if an error occurspublic void setAuthenticationService(java.lang.String domainName, AuthenticationServiceDescriptor serviceDescriptor) throws ManagerException
domainName
- target domain nameserviceDescriptor
- service descriptor
ManagerException
- if an error occurspublic void testAuthenticationService(ServiceDescriptor descriptor, java.lang.String login, java.lang.String password) throws ManagerException
descriptor
- subsystem descriptorlogin
- user loginpassword
- user password
ManagerException
- if an error occurspublic void setDatastoreService(java.lang.String domainName, DatastoreServiceDescriptor serviceDescriptor) throws ManagerException
domainName
- target domain nameserviceDescriptor
- service descriptor
ManagerException
- if an error occurspublic void testDatastoreService(ServiceDescriptor descriptor) throws ManagerException
descriptor
- datastore service descriptor
ManagerException
- if an error occurspublic void setLogService(java.lang.String domainName, LogServiceDescriptor serviceDescriptor, LogConfiguration configuration) throws ManagerException
domainName
- target domain nameserviceDescriptor
- service descriptorconfiguration
- log service configuration
ManagerException
- if an error occurspublic void setPasswordService(java.lang.String domainName, PasswordServiceDescriptor serviceDescriptor) throws ManagerException
domainName
- target domain nameserviceDescriptor
- service descriptor
ManagerException
- if an error occurspublic void testLogService(ServiceDescriptor descriptor) throws ManagerException
descriptor
- service descriptor
ManagerException
- if an error occurspublic void setTransportServices(java.lang.String domainName, TransportServiceDescriptor[] serviceDescriptors, Configuration[] configurations) throws ManagerException
domainName
- target domain nameserviceDescriptors
- service descriptorsconfigurations
- common services configurations,
FtpConfiguration, SftpConfiguration, HttpConfiguration, WebDavConfiguration
ManagerException
- if an error occurspublic void setRestrictionServices(java.lang.String domainName, ServiceDescriptor[] serviceDescriptors) throws ManagerException
domainName
- target domain nameserviceDescriptors
- service descriptor
ManagerException
- if an error occurspublic void setEventService(java.lang.String domainName, ServiceDescriptor serviceDescriptor) throws ManagerException
domainName
- target domain nameserviceDescriptor
- service descriptor
ManagerException
- if an error occurspublic com.jscape.inet.mft.common.Statistics getStatistics(java.lang.String name) throws ManagerException
name
- the domain name
ManagerException
- if an error occurspublic java.lang.String getLog(java.lang.String name, int recordsCount) throws ManagerException
name
- the domain namerecordsCount
- desired records count
ManagerException
- if an error occurspublic IPAccessRule[] getAccessRules(java.lang.String name) throws ManagerException
name
- the domain name
ManagerException
- if an error occurspublic void setAccessRules(java.lang.String domainName, IPAccessRule[] rules) throws ManagerException
domainName
- the domain namerules
- access rules
ManagerException
- if an error occurspublic Account[] getAccounts(java.lang.String domainName) throws ManagerException
domainName
- the domain name.
ManagerException
- if an error occurspublic void addAccount(java.lang.String domainName, Account account) throws ManagerException
domainName
- the domain nameaccount
- the new account
ManagerException
- if an error occurspublic void deleteAccount(java.lang.String domaiName, java.lang.String accountName) throws ManagerException
domaiName
- the domain nameaccountName
- account name
ManagerException
- if an error occurspublic Group[] getGroups(java.lang.String domainName) throws ManagerException
domainName
- the domain name
ManagerException
- if an error occurspublic void addGroup(java.lang.String domainName, Group group) throws ManagerException
domainName
- the domain namegroup
- the new group
ManagerException
- if an error occurspublic void deleteGroup(java.lang.String domainName, java.lang.String groupName) throws ManagerException
domainName
- the domain namegroupName
- the group name
ManagerException
- if an error occurspublic void kickUser(java.lang.String domainName, java.lang.String accountName, boolean disableAccount) throws ManagerException
domainName
- the domain nameaccountName
- the account namedisableAccount
- if true
account will be disabled
ManagerException
- if an error occurspublic Report[] getReports(java.lang.String domainName) throws ManagerException
domainName
- the domain name
ManagerException
- if an error occurspublic void addReport(java.lang.String domainName, Report report) throws ManagerException
domainName
- the domain namereport
- a new report instance
ManagerException
- if an error occurspublic void deleteReport(java.lang.String domainName, java.lang.String reportName) throws ManagerException
domainName
- the domain namereportName
- the report name
ManagerException
- if an error occurspublic void addResource(java.lang.String domainName, ResourceDescriptor resource) throws ManagerException
domainName
- the domain nameresource
- a new remote resource descriptor
ManagerException
- if an error occurspublic void deleteResource(java.lang.String domainName, java.lang.String resourceName) throws ManagerException
domainName
- the domain nameresourceName
- the resource name
ManagerException
- if an error occurspublic void testResource(ResourceDescriptor resource) throws ManagerException
resource
- the resource to test
ManagerException
- if an error occurspublic void addDirectoryMonitor(java.lang.String domainName, DirectoryMonitor monitor) throws ManagerException
domainName
- domain namemonitor
- directory monitor instance
ManagerException
- if an error occurspublic void deleteDirectoryMonitor(java.lang.String domainName, java.lang.String monitorName) throws ManagerException
domainName
- domain namemonitorName
- monitor name
ManagerException
- if an error occurspublic DirectoryMonitor[] getDirectoryMonitors(java.lang.String domainName) throws ManagerException
domainName
- domain name
ManagerException
- if an error occurspublic void startAllDomains() throws ManagerException
ManagerException
- if an error occurspublic void startDomain(java.lang.String name) throws ManagerException
name
- the domain name
ManagerException
- if an error occurspublic void stopAllDomains() throws ManagerException
ManagerException
- if an error occurspublic void stopDomain(java.lang.String name) throws ManagerException
name
- the domain name
ManagerException
- if an error occurspublic void executeRequest(com.jscape.inet.mft.management.requests.ManagerRequest request) throws ManagerException
request
- Instance of ManagerRequest that is going to be
executed
ManagerException
- if an error occurspublic com.jscape.util.event.CommonEventContext getContext()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |