added javadoc

This commit is contained in:
2021-09-03 12:56:35 -04:00
parent e2bde23f64
commit 96bdcda33a
7 changed files with 53 additions and 13 deletions

13
pom.xml
View File

@@ -148,6 +148,19 @@
</dependency> </dependency>
</dependencies> </dependencies>
</plugin> </plugin>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<id>javadoc</id>
<phase>package</phase>
<goals><goal>jar</goal></goals>
<configuration>
<show>public</show>
</configuration>
</execution>
</executions>
</plugin>
</plugins> </plugins>
</build> </build>

View File

@@ -7,6 +7,14 @@ import org.springframework.context.annotation.Configuration;
import com.inteligr8.rs.ClientCxfConfiguration; import com.inteligr8.rs.ClientCxfConfiguration;
import com.inteligr8.rs.ClientJerseyConfiguration; import com.inteligr8.rs.ClientJerseyConfiguration;
/**
* This class provides a POJO &amp; 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 @Configuration
@ComponentScan @ComponentScan
public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJerseyConfiguration { public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJerseyConfiguration {
@@ -49,7 +57,7 @@ public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJer
@Value("${content.service.jersey.putBodyRequired:true}") @Value("${content.service.jersey.putBodyRequired:true}")
private boolean putBodyRequired; private boolean putBodyRequired;
public String getBaseUrl() { public String getBaseUrl() {
return this.baseUrl; return this.baseUrl;
} }
@@ -77,7 +85,7 @@ public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJer
public String getBearerToken() { public String getBearerToken() {
return this.bearerToken; return this.bearerToken;
} }
public void setBearerToken(String bearerToken) { public void setBearerToken(String bearerToken) {
this.bearerToken = bearerToken; this.bearerToken = bearerToken;
} }
@@ -85,7 +93,7 @@ public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJer
public String getOAuthTokenUrl() { public String getOAuthTokenUrl() {
return this.oAuthTokenUrl; return this.oAuthTokenUrl;
} }
public void setOAuthTokenUrl(String oAuthTokenUrl) { public void setOAuthTokenUrl(String oAuthTokenUrl) {
this.oAuthTokenUrl = oAuthTokenUrl; this.oAuthTokenUrl = oAuthTokenUrl;
} }
@@ -109,7 +117,7 @@ public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJer
public String getOAuthAuthCode() { public String getOAuthAuthCode() {
return this.oAuthAuthCode; return this.oAuthAuthCode;
} }
public void setOAuthAuthCode(String oAuthAuthCode) { public void setOAuthAuthCode(String oAuthAuthCode) {
this.oAuthAuthCode = oAuthAuthCode; this.oAuthAuthCode = oAuthAuthCode;
} }
@@ -117,7 +125,7 @@ public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJer
public String getOAuthAuthRedirectUri() { public String getOAuthAuthRedirectUri() {
return this.oAuthAuthRedirectUri; return this.oAuthAuthRedirectUri;
} }
public void setOAuthAuthRedirectUri(String oAuthAuthRedirectUri) { public void setOAuthAuthRedirectUri(String oAuthAuthRedirectUri) {
this.oAuthAuthRedirectUri = oAuthAuthRedirectUri; this.oAuthAuthRedirectUri = oAuthAuthRedirectUri;
} }
@@ -141,7 +149,7 @@ public class AcsClientConfiguration implements ClientCxfConfiguration, ClientJer
public boolean isDefaultBusEnabled() { public boolean isDefaultBusEnabled() {
return this.defaultBusEnabled; return this.defaultBusEnabled;
} }
public void setDefaultBusEnabled(boolean defaultBusEnabled) { public void setDefaultBusEnabled(boolean defaultBusEnabled) {
this.defaultBusEnabled = defaultBusEnabled; this.defaultBusEnabled = defaultBusEnabled;
} }

View File

@@ -8,7 +8,12 @@ import com.inteligr8.rs.ClientCxfConfiguration;
import com.inteligr8.rs.ClientCxfImpl; import com.inteligr8.rs.ClientCxfImpl;
/** /**
* Configured JAX-RS Client & WebTarget for ACS & CXF * This class provides a POJO &amp; 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") @Component("acs.client.cxf")
@Lazy @Lazy

View File

@@ -8,7 +8,12 @@ import com.inteligr8.rs.ClientJerseyConfiguration;
import com.inteligr8.rs.ClientJerseyImpl; import com.inteligr8.rs.ClientJerseyImpl;
/** /**
* Configured JAX-RS Client & WebTarget for ACS & Jersey * This class provides a POJO &amp; 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") @Component("acs.client.jersey")
@Lazy @Lazy

View File

@@ -31,7 +31,10 @@ import com.inteligr8.rs.Client;
import com.inteligr8.rs.ClientConfiguration; 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 { public abstract class AcsPublicRestApi {
@@ -74,7 +77,7 @@ public abstract class AcsPublicRestApi {
public AuditApi getAuditApi() { public AuditApi getAuditApi() {
return this.getApi(AuditApi.class); return this.getApi(AuditApi.class);
} }
public AuditApi getAuditApi(AuthorizationFilter authFilter) { public AuditApi getAuditApi(AuthorizationFilter authFilter) {
return this.getApi(authFilter, AuditApi.class); return this.getApi(authFilter, AuditApi.class);
} }

View File

@@ -10,7 +10,10 @@ import com.inteligr8.rs.Client;
import com.inteligr8.rs.ClientConfiguration; 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") @Component("acs.api.cxf")
@Lazy @Lazy
@@ -36,7 +39,7 @@ public class AcsPublicRestApiCxfImpl extends AcsPublicRestApi {
ClientConfiguration getConfig() { ClientConfiguration getConfig() {
return this.client.getConfig(); return this.client.getConfig();
} }
@Override @Override
Client getClient() { Client getClient() {
return this.client; return this.client;

View File

@@ -10,7 +10,10 @@ import com.inteligr8.rs.Client;
import com.inteligr8.rs.ClientConfiguration; 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") @Component("acs.api.jersey")
@Lazy @Lazy