diff --git a/pom.xml b/pom.xml index 1c2c174..3e28155 100644 --- a/pom.xml +++ b/pom.xml @@ -148,6 +148,19 @@ + + maven-javadoc-plugin + + + javadoc + package + jar + + public + + + + diff --git a/src/main/java/com/inteligr8/alfresco/acs/AcsClientConfiguration.java b/src/main/java/com/inteligr8/alfresco/acs/AcsClientConfiguration.java index 777e81c..b436423 100644 --- a/src/main/java/com/inteligr8/alfresco/acs/AcsClientConfiguration.java +++ b/src/main/java/com/inteligr8/alfresco/acs/AcsClientConfiguration.java @@ -7,6 +7,14 @@ import org.springframework.context.annotation.Configuration; import com.inteligr8.rs.ClientCxfConfiguration; import com.inteligr8.rs.ClientJerseyConfiguration; +/** + * This class provides a POJO & Spring-based implementation of the + * ClientConfiguration interface. You can use it outside of the Spring + * context, but you will need the spring-context and spring-beans libraries in + * your non-Spring application. + * + * @author brian@inteligr8.com + */ @Configuration @ComponentScan public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJerseyConfiguration { @@ -49,7 +57,7 @@ public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJer @Value("${content.service.jersey.putBodyRequired:true}") private boolean putBodyRequired; - + public String getBaseUrl() { return this.baseUrl; } @@ -77,7 +85,7 @@ public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJer public String getBearerToken() { return this.bearerToken; } - + public void setBearerToken(String bearerToken) { this.bearerToken = bearerToken; } @@ -85,7 +93,7 @@ public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJer public String getOAuthTokenUrl() { return this.oAuthTokenUrl; } - + public void setOAuthTokenUrl(String oAuthTokenUrl) { this.oAuthTokenUrl = oAuthTokenUrl; } @@ -109,7 +117,7 @@ public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJer public String getOAuthAuthCode() { return this.oAuthAuthCode; } - + public void setOAuthAuthCode(String oAuthAuthCode) { this.oAuthAuthCode = oAuthAuthCode; } @@ -117,7 +125,7 @@ public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJer public String getOAuthAuthRedirectUri() { return this.oAuthAuthRedirectUri; } - + public void setOAuthAuthRedirectUri(String oAuthAuthRedirectUri) { this.oAuthAuthRedirectUri = oAuthAuthRedirectUri; } @@ -141,7 +149,7 @@ public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJer public boolean isDefaultBusEnabled() { return this.defaultBusEnabled; } - + public void setDefaultBusEnabled(boolean defaultBusEnabled) { this.defaultBusEnabled = defaultBusEnabled; } diff --git a/src/main/java/com/inteligr8/alfresco/acs/AcsClientCxfImpl.java b/src/main/java/com/inteligr8/alfresco/acs/AcsClientCxfImpl.java index 8c5c44c..7c78d77 100644 --- a/src/main/java/com/inteligr8/alfresco/acs/AcsClientCxfImpl.java +++ b/src/main/java/com/inteligr8/alfresco/acs/AcsClientCxfImpl.java @@ -8,7 +8,12 @@ import com.inteligr8.rs.ClientCxfConfiguration; import com.inteligr8.rs.ClientCxfImpl; /** - * Configured JAX-RS Client & WebTarget for ACS & CXF + * This class provides a POJO & Spring-based implementation of the Apache + * CXF client. You can use it outside of the Spring context, but you will need + * the spring-context and spring-beans libraries in your non-Spring + * application. + * + * @author brian@inteligr8.com */ @Component("acs.client.cxf") @Lazy diff --git a/src/main/java/com/inteligr8/alfresco/acs/AcsClientJerseyImpl.java b/src/main/java/com/inteligr8/alfresco/acs/AcsClientJerseyImpl.java index 09a03a8..68fc263 100644 --- a/src/main/java/com/inteligr8/alfresco/acs/AcsClientJerseyImpl.java +++ b/src/main/java/com/inteligr8/alfresco/acs/AcsClientJerseyImpl.java @@ -8,7 +8,12 @@ import com.inteligr8.rs.ClientJerseyConfiguration; import com.inteligr8.rs.ClientJerseyImpl; /** - * Configured JAX-RS Client & WebTarget for ACS & Jersey + * This class provides a POJO & Spring-based implementation of the Apache + * CXF client. You can use it outside of the Spring context, but you will need + * the spring-context and spring-beans libraries in your non-Spring + * application. + * + * @author brian@inteligr8.com */ @Component("acs.client.jersey") @Lazy diff --git a/src/main/java/com/inteligr8/alfresco/acs/AcsPublicRestApi.java b/src/main/java/com/inteligr8/alfresco/acs/AcsPublicRestApi.java index fa70e6f..4c38b15 100644 --- a/src/main/java/com/inteligr8/alfresco/acs/AcsPublicRestApi.java +++ b/src/main/java/com/inteligr8/alfresco/acs/AcsPublicRestApi.java @@ -31,7 +31,10 @@ import com.inteligr8.rs.Client; import com.inteligr8.rs.ClientConfiguration; /** - * Alfresco Content Services Spring-ready API + * This class serves as the base implementation for the JAX-RS API for the ACS + * Public ReST API. + * + * @author brian@inteligr8.com */ public abstract class AcsPublicRestApi { @@ -74,7 +77,7 @@ public abstract class AcsPublicRestApi { public AuditApi getAuditApi() { return this.getApi(AuditApi.class); } - + public AuditApi getAuditApi(AuthorizationFilter authFilter) { return this.getApi(authFilter, AuditApi.class); } diff --git a/src/main/java/com/inteligr8/alfresco/acs/AcsPublicRestApiCxfImpl.java b/src/main/java/com/inteligr8/alfresco/acs/AcsPublicRestApiCxfImpl.java index 530b6ae..b31bd5f 100644 --- a/src/main/java/com/inteligr8/alfresco/acs/AcsPublicRestApiCxfImpl.java +++ b/src/main/java/com/inteligr8/alfresco/acs/AcsPublicRestApiCxfImpl.java @@ -10,7 +10,10 @@ import com.inteligr8.rs.Client; import com.inteligr8.rs.ClientConfiguration; /** - * Alfresco Content Services Spring-ready API for CXF + * This class provides the Apache CXF client to the JAX-RS API for the ACS + * Public ReST API. It also provides extension API helpers. + * + * @author brian@inteligr8.com */ @Component("acs.api.cxf") @Lazy @@ -36,7 +39,7 @@ public class AcsPublicRestApiCxfImpl extends AcsPublicRestApi { ClientConfiguration getConfig() { return this.client.getConfig(); } - + @Override Client getClient() { return this.client; diff --git a/src/main/java/com/inteligr8/alfresco/acs/AcsPublicRestApiJerseyImpl.java b/src/main/java/com/inteligr8/alfresco/acs/AcsPublicRestApiJerseyImpl.java index e01001f..69e0708 100644 --- a/src/main/java/com/inteligr8/alfresco/acs/AcsPublicRestApiJerseyImpl.java +++ b/src/main/java/com/inteligr8/alfresco/acs/AcsPublicRestApiJerseyImpl.java @@ -10,7 +10,10 @@ import com.inteligr8.rs.Client; import com.inteligr8.rs.ClientConfiguration; /** - * Alfresco Content Services Spring-ready API for Jersey + * This class provides the Jersey client to the JAX-RS API for the ACS Public + * ReST API. It also provides extension API helpers. + * + * @author brian@inteligr8.com */ @Component("acs.api.jersey") @Lazy