Author: jbernhardt
Date: Wed Jan 30 13:32:20 2013
New Revision: 1440409
URL: http://svn.apache.org/viewvc?rev=1440409&view=rev
Log:
[SYNCOPE-231]
* adding JAVA DOC
* renaming validate to check for connector service
* Code cleanup
Modified:
syncope/trunk/client/src/main/java/org/apache/syncope/client/services/proxy/ConnectorServiceProxy.java
syncope/trunk/common/src/main/java/org/apache/syncope/common/SyncopeConstants.java
syncope/trunk/common/src/main/java/org/apache/syncope/common/services/ConfigurationService.java
syncope/trunk/common/src/main/java/org/apache/syncope/common/services/ConnectorService.java
syncope/trunk/console/src/main/java/org/apache/syncope/console/rest/ConnectorRestClient.java
syncope/trunk/core/src/main/java/org/apache/syncope/core/services/ConnectorServiceImpl.java
syncope/trunk/core/src/test/java/org/apache/syncope/core/rest/ConnInstanceTestITCase.java
Modified:
syncope/trunk/client/src/main/java/org/apache/syncope/client/services/proxy/ConnectorServiceProxy.java
URL:
http://svn.apache.org/viewvc/syncope/trunk/client/src/main/java/org/apache/syncope/client/services/proxy/ConnectorServiceProxy.java?rev=1440409&r1=1440408&r2=1440409&view=diff
==============================================================================
---
syncope/trunk/client/src/main/java/org/apache/syncope/client/services/proxy/ConnectorServiceProxy.java
(original)
+++
syncope/trunk/client/src/main/java/org/apache/syncope/client/services/proxy/ConnectorServiceProxy.java
Wed Jan 30 13:32:20 2013
@@ -106,7 +106,7 @@ public class ConnectorServiceProxy exten
}
@Override
- public boolean validate(final ConnInstanceTO connectorTO) {
+ public boolean check(final ConnInstanceTO connectorTO) {
return getRestTemplate().postForObject(baseUrl +
"connector/check.json", connectorTO, Boolean.class);
}
Modified:
syncope/trunk/common/src/main/java/org/apache/syncope/common/SyncopeConstants.java
URL:
http://svn.apache.org/viewvc/syncope/trunk/common/src/main/java/org/apache/syncope/common/SyncopeConstants.java?rev=1440409&r1=1440408&r2=1440409&view=diff
==============================================================================
---
syncope/trunk/common/src/main/java/org/apache/syncope/common/SyncopeConstants.java
(original)
+++
syncope/trunk/common/src/main/java/org/apache/syncope/common/SyncopeConstants.java
Wed Jan 30 13:32:20 2013
@@ -36,7 +36,7 @@ public class SyncopeConstants {
* to an object after its creation. HTTP Response after PUT operation
should contain this
* key with resource id as its value.
*/
- public static final String REST_HEADER_ID = "org.apache.syncope.id";
+ public static final String REST_HEADER_ID =
"org.apache.syncope.resource.id";
public static final String DEFAULT_ENCODING = "UTF-8";
Modified:
syncope/trunk/common/src/main/java/org/apache/syncope/common/services/ConfigurationService.java
URL:
http://svn.apache.org/viewvc/syncope/trunk/common/src/main/java/org/apache/syncope/common/services/ConfigurationService.java?rev=1440409&r1=1440408&r2=1440409&view=diff
==============================================================================
---
syncope/trunk/common/src/main/java/org/apache/syncope/common/services/ConfigurationService.java
(original)
+++
syncope/trunk/common/src/main/java/org/apache/syncope/common/services/ConfigurationService.java
Wed Jan 30 13:32:20 2013
@@ -36,33 +36,63 @@ import org.apache.syncope.common.to.Vali
@Path("configurations")
public interface ConfigurationService {
+ /**
+ * Creates a new configuration element.
+ *
+ * @param configurationTO Configuration to be stored.
+ * @return Response containing URI location for created resource.
+ */
@POST
Response create(ConfigurationTO configurationTO);
+ /**
+ * @return Returns configuration as an downloadable content.xml database
export file.
+ */
@GET
@Path("dbDump")
Response dbExport();
+ /**
+ * @param key Deletes configuration with matching key.
+ */
@DELETE
@Path("{key}")
void delete(@PathParam("key") String key);
+ /**
+ * @return Returns a list of known mail-template names.
+ */
@GET
@Path("mailTemplates")
Set<MailTemplateTO> getMailTemplates();
+ /**
+ * @return Returns a list of known validator names.
+ */
@GET
@Path("validators")
Set<ValidatorTO> getValidators();
+ /**
+ * @return Returns a list of all configuration elements.
+ */
@GET
List<ConfigurationTO> list();
+ /**
+ * @param key Identifier of configuration to be read.
+ * @return Returns configuration element with matching key.
+ */
@GET
@Path("{key}")
ConfigurationTO read(@PathParam("key") String key);
+ /**
+ * @param key Overwrites configuration element with matching key.
+ * @param configurationTO New configuration
+ */
@PUT
@Path("{key}")
void update(@PathParam("key") String key, ConfigurationTO configurationTO);
+
}
Modified:
syncope/trunk/common/src/main/java/org/apache/syncope/common/services/ConnectorService.java
URL:
http://svn.apache.org/viewvc/syncope/trunk/common/src/main/java/org/apache/syncope/common/services/ConnectorService.java?rev=1440409&r1=1440408&r2=1440409&view=diff
==============================================================================
---
syncope/trunk/common/src/main/java/org/apache/syncope/common/services/ConnectorService.java
(original)
+++
syncope/trunk/common/src/main/java/org/apache/syncope/common/services/ConnectorService.java
Wed Jan 30 13:32:20 2013
@@ -39,46 +39,86 @@ import org.apache.syncope.common.types.C
@Path("connectors")
public interface ConnectorService {
+ /**
+ * Creates a new connector instance.
+ *
+ * @param connectorTO Connector to be created.
+ * @return Response containing URI location for created resource.
+ */
@POST
Response create(ConnInstanceTO connectorTO);
+ /**
+ * @param connectorId Deletes connector with matching id.
+ */
@DELETE
@Path("{connectorId}")
void delete(@PathParam("connectorId") Long connectorId);
+ /**
+ * @param lang Language to select bundles from. Default language is
English.
+ * @return Returns known bundles in selected language.
+ */
@GET
@Path("bundles")
List<ConnBundleTO> getBundles(@QueryParam("lang") String lang);
+ /**
+ * @param connectorId ConnectorID to read configuration from.
+ * @return Returns configuration for selected connector.
+ */
@GET
@Path("{connectorId}/configuration")
- List<ConnConfProperty> getConfigurationProperties(
- @PathParam("connectorId") Long connectorId);
+ List<ConnConfProperty>
getConfigurationProperties(@PathParam("connectorId") Long connectorId);
+ /**
+ * @param connectorId ConnectorID to be used for schema lookup.
+ * @param connectorTO Connector object to provide special configuration
properties.
+ * @param showAll If set to true, all schema names will be shown,
including special ones like '__PASSWORD__'.
+ * Default is false.
+ * @return Returns schema names for matching connector.
+ */
@POST
@Path("{connectorId}/schemas")
- List<SchemaTO> getSchemaNames(
- @PathParam("connectorId") Long connectorId,
- ConnInstanceTO connectorTO,
- @QueryParam("showall") @DefaultValue("false") boolean showall);
+ List<SchemaTO> getSchemaNames(@PathParam("connectorId") Long connectorId,
ConnInstanceTO connectorTO,
+ @QueryParam("showAll") @DefaultValue("false") boolean showAll);
+ /**
+ * @param lang Language to select connectors for. Default language is
English.
+ * @return Returns a list of all connectors with matching language.
+ */
@GET
List<ConnInstanceTO> list(@QueryParam("lang") String lang);
+ /**
+ * @param connectorId ConnectorID to be read.
+ * @return Returns connector with matching id.
+ */
@GET
@Path("{connectorId}")
ConnInstanceTO read(@PathParam("connectorId") Long connectorId);
+ /**
+ * @param resourceName Resource name to be used for connector lookup.
+ * @return Returns connector for matching resourceName.
+ */
@GET
- ConnInstanceTO readConnectorBean(
- @MatrixParam("resourceName") String resourceName);
+ ConnInstanceTO readConnectorBean(@MatrixParam("resourceName") String
resourceName);
+ /**
+ * @param connectorId Overwrites connector with matching key.
+ * @param connectorTO Connector to be stored.
+ */
@PUT
@Path("{connectorId}")
- void update(@PathParam("connectorId") Long connectorId,
- ConnInstanceTO connectorTO);
+ void update(@PathParam("connectorId") Long connectorId, ConnInstanceTO
connectorTO);
+ /**
+ * @param connectorTO ConnectorTO to be used for connection check
+ * @return True is connection could be established.
+ */
@POST
- @Path("validate")
- boolean validate(ConnInstanceTO connectorTO);
+ @Path("check")
+ boolean check(ConnInstanceTO connectorTO);
+
}
Modified:
syncope/trunk/console/src/main/java/org/apache/syncope/console/rest/ConnectorRestClient.java
URL:
http://svn.apache.org/viewvc/syncope/trunk/console/src/main/java/org/apache/syncope/console/rest/ConnectorRestClient.java?rev=1440409&r1=1440408&r2=1440409&view=diff
==============================================================================
---
syncope/trunk/console/src/main/java/org/apache/syncope/console/rest/ConnectorRestClient.java
(original)
+++
syncope/trunk/console/src/main/java/org/apache/syncope/console/rest/ConnectorRestClient.java
Wed Jan 30 13:32:20 2013
@@ -159,7 +159,7 @@ public class ConnectorRestClient extends
connector.setConfiguration(filterProperties(connector.getConfiguration()));
try {
- return getService(ConnectorService.class).validate(connectorTO);
+ return getService(ConnectorService.class).check(connectorTO);
} catch (Exception e) {
LOG.error("Connector not found {}", connector, e);
return false;
Modified:
syncope/trunk/core/src/main/java/org/apache/syncope/core/services/ConnectorServiceImpl.java
URL:
http://svn.apache.org/viewvc/syncope/trunk/core/src/main/java/org/apache/syncope/core/services/ConnectorServiceImpl.java?rev=1440409&r1=1440408&r2=1440409&view=diff
==============================================================================
---
syncope/trunk/core/src/main/java/org/apache/syncope/core/services/ConnectorServiceImpl.java
(original)
+++
syncope/trunk/core/src/main/java/org/apache/syncope/core/services/ConnectorServiceImpl.java
Wed Jan 30 13:32:20 2013
@@ -100,7 +100,7 @@ public class ConnectorServiceImpl implem
}
@Override
- public boolean validate(final ConnInstanceTO connectorTO) {
+ public boolean check(final ConnInstanceTO connectorTO) {
return (Boolean) connectorController.check(new
DummyHTTPServletResponse(), connectorTO).getModel().values()
.iterator().next();
}
Modified:
syncope/trunk/core/src/test/java/org/apache/syncope/core/rest/ConnInstanceTestITCase.java
URL:
http://svn.apache.org/viewvc/syncope/trunk/core/src/test/java/org/apache/syncope/core/rest/ConnInstanceTestITCase.java?rev=1440409&r1=1440408&r2=1440409&view=diff
==============================================================================
---
syncope/trunk/core/src/test/java/org/apache/syncope/core/rest/ConnInstanceTestITCase.java
(original)
+++
syncope/trunk/core/src/test/java/org/apache/syncope/core/rest/ConnInstanceTestITCase.java
Wed Jan 30 13:32:20 2013
@@ -506,7 +506,7 @@ public class ConnInstanceTestITCase exte
// set connector configuration
connectorTO.setConfiguration(conf);
- Boolean verify = connectorService.validate(connectorTO);
+ Boolean verify = connectorService.check(connectorTO);
assertTrue(verify);
@@ -514,7 +514,7 @@ public class ConnInstanceTestITCase exte
password.setValues(Collections.singletonList("password"));
conf.add(password);
- verify = connectorService.validate(connectorTO);
+ verify = connectorService.check(connectorTO);
assertFalse(verify);
}
@@ -594,7 +594,7 @@ public class ConnInstanceTestITCase exte
try {
- assertFalse(connectorService.validate(connectorTO));
+ assertFalse(connectorService.check(connectorTO));
Response response = connectorService.create(connectorTO);
if (response.getStatus() != org.apache.http.HttpStatus.SC_CREATED)
{
