com.anrisoftware.sscontrol.httpd.roundcube.RoundcubeService Maven / Gradle / Ivy
/*
* Copyright 2014 Erwin Müller
*
* This file is part of sscontrol-httpd-roundcube.
*
* sscontrol-httpd-roundcube is free software: you can redistribute it and/or modify it
* under the terms of the GNU Affero General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* sscontrol-httpd-roundcube is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
* for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with sscontrol-httpd-roundcube. If not, see args, @Assisted Domain domain) {
this.service = webServiceFactory.create(SERVICE_NAME, args, domain);
this.statementsMap = service.getStatementsMap();
this.domain = domain;
setupStatements(statementsMap, args);
}
private void setupStatements(StatementsMap map, Map args) {
map.addAllowed(OVERRIDE_KEY, BACKUP_KEY, DATABASE_KEY, SMTP_KEY);
map.addAllowedKeys(OVERRIDE_KEY, MODE_KEY);
map.addAllowedKeys(DATABASE_KEY, USER_KEY, PASSWORD_KEY, HOST_KEY,
DRIVER_KEY);
map.addAllowedKeys(BACKUP_KEY, TARGET_KEY);
map.addAllowedKeys(SMTP_KEY, USER_KEY, PASSWORD_KEY);
map.setAllowValue(true, DATABASE_KEY, SMTP_KEY);
}
@Inject
public void setStatementsTable(StatementsTableFactory factory) {
StatementsTable table = factory.create(factory, SERVICE_NAME);
table.addAllowed(DEBUG_KEY, SERVER_KEY, HOST_KEY);
table.addAllowedKeys(DEBUG_KEY, LEVEL_KEY);
table.addAllowedKeys(SERVER_KEY, HOST_KEY, PORT_KEY);
table.addAllowedKeys(HOST_KEY, DOMAIN_KEY);
this.statementsTable = table;
}
@Override
public Domain getDomain() {
return domain;
}
@Override
public String getName() {
return SERVICE_NAME;
}
public StatementsMap getStatementsMap() {
return service.getStatementsMap();
}
public void setAlias(String alias) throws ServiceException {
service.setAlias(alias);
}
@Override
public String getAlias() {
return service.getAlias();
}
public void setId(String id) throws ServiceException {
service.setId(id);
}
@Override
public String getId() {
return service.getId();
}
public void setRef(String ref) throws ServiceException {
service.setRef(ref);
}
@Override
public String getRef() {
return service.getRef();
}
public void setRefDomain(String ref) throws ServiceException {
service.setRefDomain(ref);
}
@Override
public String getRefDomain() {
return service.getRefDomain();
}
public void setPrefix(String prefix) throws ServiceException {
service.setPrefix(prefix);
}
@Override
public String getPrefix() {
return service.getPrefix();
}
/**
* Returns the debug level settings for the modules:
*
* - roundcube
* - php
*
*
* Example:
*
*
* setup "roundcube", {
* debug "roundcube", level: 1
* debug "smtplog", level: 1
* debug "logins", level: 1
* debug "session", level: 1
* debug "sql", level: 1
* debug "imap", level: 1
* debug "ldap", level: 1
* debug "smtp", level: 1
* debug "php", level: 1
* }
*
*
* @return the debug logging {@link Map} settings or {@code null}.
*/
public Map getDebug() {
return statementsTable.tableKeys(DEBUG_KEY, LEVEL_KEY);
}
/**
* Returns the override mode in case the service is already installed inside
* the service prefix.
*
* Example:
*
*
* setup "roundcube", {
* override mode: no
* }
*
*
* @return the {@link OverrideMode} or the {@link YesNoFlag} or {@code null}
*/
public Object getOverrideMode() {
return statementsMap.mapValue(OVERRIDE_KEY, MODE_KEY);
}
/**
* Returns the backup target.
*
* Example:
*
*
* setup "roundcube", {
* backup target: "/var/backups"
* }
*
*
* @return the backup {@link URI} target or {@code null}.
*/
public URI getBackupTarget() {
return statementsMap.mapValueAsURI(BACKUP_KEY, TARGET_KEY);
}
/**
* Returns the database settings.
*
* - "database" the database name;
* - "user" optionally, the database user name;
* - "password" optionally, the user password;
* - "host" optionally, the database host;
* - "driver" optionally, the database driver;
*
*
* Example:
*
*
* setup "roundcube", {
* database "roundcubedb", user: "userdb", password: "userpassdb", host: "localhost", driver: "mysql"
* }
*
*
* @return the {@link Map} with the database settings or {@code null}.
*/
public Map getDatabase() {
StatementsMap smap = statementsMap;
String database = smap.value(DATABASE_KEY);
if (database != null) {
Map map = new HashMap();
map.put(DATABASE_KEY, database);
map.put(USER_KEY, smap.mapValue(DATABASE_KEY, USER_KEY));
map.put(PASSWORD_KEY, smap.mapValue(DATABASE_KEY, PASSWORD_KEY));
map.put(HOST_KEY, smap.mapValue(DATABASE_KEY, HOST_KEY));
map.put(DRIVER_KEY, smap.mapValue(DATABASE_KEY, DRIVER_KEY));
return unmodifiableMap(map);
} else {
return null;
}
}
/**
* Returns the SMTP server settings.
*
* - "server" the SMTP server;
* - "user" optionally, the SMTP login user name;
* - "password" optionally, the SMTP login password;
*
*
* Example:
*
*
* setup "roundcube", {
* smtp "tls://%h", user: "usersmtp", password: "passwordsmtp"
* }
*
*
* @return the {@link Map} with the SMTP server settings or {@code null}.
*/
public Map getSmtpServer() {
StatementsMap smap = statementsMap;
String smtp = smap.value(SMTP_KEY);
if (smtp != null) {
Map map = new HashMap();
map.put(SERVER_KEY, smtp);
map.put(USER_KEY, smap.mapValue(SMTP_KEY, USER_KEY));
map.put(PASSWORD_KEY, smap.mapValue(SMTP_KEY, PASSWORD_KEY));
return unmodifiableMap(map);
} else {
return null;
}
}
/**
* Returns the IMAP hosts.
*
* - name := host
*
*
* Example:
*
*
* setup "roundcube", {
* server "Default Server", host: "mail.example.com"
* server "Webmail Server", host: "webmail.example.com"
* }
*
*
* @return the {@link Map} with the IMAP hosts or {@code null}.
*/
public Map getImapServers() {
return statementsTable.tableKeys(SERVER_KEY, HOST_KEY);
}
/**
* Returns the default IMAP host.
*
* Example:
*
*
* setup "roundcube", {
* server "default", host: "localhost"
* }
*
*
* @return the {@link String} host or {@code null}.
*/
public String getImapServer() {
StatementsTable tmap = statementsTable;
Map map = tmap.tableKeys(SERVER_KEY, HOST_KEY);
if (map != null) {
return (String) map.get("default");
} else {
return null;
}
}
/**
* Returns the default IMAP port.
*
* Example:
*
*
* setup "roundcube", {
* server "default", port: 143
* }
*
*
* @return the {@link Integer} host or {@code null}.
*/
public Integer getImapPort() {
StatementsTable tmap = statementsTable;
Map map = tmap.tableKeys(SERVER_KEY, PORT_KEY);
if (map != null) {
return (Integer) map.get("default");
} else {
return null;
}
}
/**
* Returns the IMAP domains.
*
* - host := domain
*
*
* Example:
*
*
* setup "roundcube", {
* host "example.com", domain: "mail.example.com"
* host "otherdomain.com", domain: "othermail.example.com"
* }
*
*
* @return the {@link Map} with the IMAP domains or {@code null}.
*/
public Map getImapDomains() {
return statementsTable.tableKeys(HOST_KEY, DOMAIN_KEY);
}
/**
* Returns the default IMAP domain.
*
* Example:
*
*
* setup "roundcube", {
* host "example.com"
* }
*
*
* @return the {@link String} the default domain or {@code null}.
*/
public String getImapDomain() {
Set values = statementsTable.tableValues(HOST_KEY);
if (values != null) {
return new ArrayList(values).get(0);
} else {
return null;
}
}
public Object methodMissing(String name, Object args)
throws StatementsException {
try {
service.methodMissing(name, args);
} catch (StatementsException e) {
statementsTable.methodMissing(name, args);
}
return null;
}
@Override
public String toString() {
return new ToStringBuilder(this).append(NAME, SERVICE_NAME)
.append(ALIAS_KEY, getAlias()).toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy