From 875060222fce50c939fccdaed9292b5e3a7e75ce Mon Sep 17 00:00:00 2001 From: Scott Frederick Date: Tue, 6 Jun 2017 11:07:25 -0500 Subject: [PATCH] Add package-level javadocs. --- pom.xml | 18 ++++++----------- .../credhub/cloud/package-info.java | 20 +++++++++++++++++++ .../credhub/configuration/package-info.java | 20 +++++++++++++++++++ .../credhub/core/package-info.java | 20 +++++++++++++++++++ .../springframework/credhub/package-info.java | 20 +++++++++++++++++++ .../support/certificate/package-info.java | 20 +++++++++++++++++++ .../credhub/support/json/package-info.java | 20 +++++++++++++++++++ .../credhub/support/package-info.java | 20 +++++++++++++++++++ .../support/password/package-info.java | 20 +++++++++++++++++++ .../credhub/support/rsa/package-info.java | 20 +++++++++++++++++++ .../credhub/support/ssh/package-info.java | 20 +++++++++++++++++++ .../credhub/support/user/package-info.java | 20 +++++++++++++++++++ .../credhub/support/value/package-info.java | 20 +++++++++++++++++++ 13 files changed, 246 insertions(+), 12 deletions(-) create mode 100644 spring-credhub-cloud-connector/src/main/java/org/springframework/credhub/cloud/package-info.java create mode 100644 spring-credhub-core/src/main/java/org/springframework/credhub/configuration/package-info.java create mode 100644 spring-credhub-core/src/main/java/org/springframework/credhub/core/package-info.java create mode 100644 spring-credhub-core/src/main/java/org/springframework/credhub/package-info.java create mode 100644 spring-credhub-core/src/main/java/org/springframework/credhub/support/certificate/package-info.java create mode 100644 spring-credhub-core/src/main/java/org/springframework/credhub/support/json/package-info.java create mode 100644 spring-credhub-core/src/main/java/org/springframework/credhub/support/package-info.java create mode 100644 spring-credhub-core/src/main/java/org/springframework/credhub/support/password/package-info.java create mode 100644 spring-credhub-core/src/main/java/org/springframework/credhub/support/rsa/package-info.java create mode 100644 spring-credhub-core/src/main/java/org/springframework/credhub/support/ssh/package-info.java create mode 100644 spring-credhub-core/src/main/java/org/springframework/credhub/support/user/package-info.java create mode 100644 spring-credhub-core/src/main/java/org/springframework/credhub/support/value/package-info.java diff --git a/pom.xml b/pom.xml index 185893a..73fb3e3 100644 --- a/pom.xml +++ b/pom.xml @@ -334,6 +334,7 @@ + spring5 @@ -387,6 +388,9 @@ package + + org.springframework.credhub.demo + @@ -397,7 +401,7 @@ - @@ -568,6 +561,7 @@ http://docs.spring.io/spring/docs/current/javadoc-api/ http://docs.oracle.com/javase/6/docs/api + org.springframework.credhub.demo diff --git a/spring-credhub-cloud-connector/src/main/java/org/springframework/credhub/cloud/package-info.java b/spring-credhub-cloud-connector/src/main/java/org/springframework/credhub/cloud/package-info.java new file mode 100644 index 0000000..e8ea82e --- /dev/null +++ b/spring-credhub-cloud-connector/src/main/java/org/springframework/credhub/cloud/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Spring Cloud Connectors support for interpolating credentials from CredHub. + */ +package org.springframework.credhub.cloud; \ No newline at end of file diff --git a/spring-credhub-core/src/main/java/org/springframework/credhub/configuration/package-info.java b/spring-credhub-core/src/main/java/org/springframework/credhub/configuration/package-info.java new file mode 100644 index 0000000..9dfc493 --- /dev/null +++ b/spring-credhub-core/src/main/java/org/springframework/credhub/configuration/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Spring configuration support for Spring CredHub. + */ +package org.springframework.credhub.configuration; \ No newline at end of file diff --git a/spring-credhub-core/src/main/java/org/springframework/credhub/core/package-info.java b/spring-credhub-core/src/main/java/org/springframework/credhub/core/package-info.java new file mode 100644 index 0000000..4c52d59 --- /dev/null +++ b/spring-credhub-core/src/main/java/org/springframework/credhub/core/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Core API abstractions for Spring CredHub. + */ +package org.springframework.credhub.core; \ No newline at end of file diff --git a/spring-credhub-core/src/main/java/org/springframework/credhub/package-info.java b/spring-credhub-core/src/main/java/org/springframework/credhub/package-info.java new file mode 100644 index 0000000..8d859aa --- /dev/null +++ b/spring-credhub-core/src/main/java/org/springframework/credhub/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Spring abstractions for interacting with Cloud Foundry CredHub. + */ +package org.springframework.credhub; \ No newline at end of file diff --git a/spring-credhub-core/src/main/java/org/springframework/credhub/support/certificate/package-info.java b/spring-credhub-core/src/main/java/org/springframework/credhub/support/certificate/package-info.java new file mode 100644 index 0000000..5d0c7b1 --- /dev/null +++ b/spring-credhub-core/src/main/java/org/springframework/credhub/support/certificate/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Java representations of CredHub certificate credentials. + */ +package org.springframework.credhub.support.certificate; \ No newline at end of file diff --git a/spring-credhub-core/src/main/java/org/springframework/credhub/support/json/package-info.java b/spring-credhub-core/src/main/java/org/springframework/credhub/support/json/package-info.java new file mode 100644 index 0000000..76ad9ec --- /dev/null +++ b/spring-credhub-core/src/main/java/org/springframework/credhub/support/json/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Java representations of CredHub JSON credentials. + */ +package org.springframework.credhub.support.json; \ No newline at end of file diff --git a/spring-credhub-core/src/main/java/org/springframework/credhub/support/package-info.java b/spring-credhub-core/src/main/java/org/springframework/credhub/support/package-info.java new file mode 100644 index 0000000..e0d8837 --- /dev/null +++ b/spring-credhub-core/src/main/java/org/springframework/credhub/support/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Java representations of CredHub requests and responses. + */ +package org.springframework.credhub.support; \ No newline at end of file diff --git a/spring-credhub-core/src/main/java/org/springframework/credhub/support/password/package-info.java b/spring-credhub-core/src/main/java/org/springframework/credhub/support/password/package-info.java new file mode 100644 index 0000000..13e2496 --- /dev/null +++ b/spring-credhub-core/src/main/java/org/springframework/credhub/support/password/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Java representations of CredHub password credentials. + */ +package org.springframework.credhub.support.password; \ No newline at end of file diff --git a/spring-credhub-core/src/main/java/org/springframework/credhub/support/rsa/package-info.java b/spring-credhub-core/src/main/java/org/springframework/credhub/support/rsa/package-info.java new file mode 100644 index 0000000..cb2403a --- /dev/null +++ b/spring-credhub-core/src/main/java/org/springframework/credhub/support/rsa/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Java representations of CredHub RSA credentials. + */ +package org.springframework.credhub.support.rsa; \ No newline at end of file diff --git a/spring-credhub-core/src/main/java/org/springframework/credhub/support/ssh/package-info.java b/spring-credhub-core/src/main/java/org/springframework/credhub/support/ssh/package-info.java new file mode 100644 index 0000000..030530f --- /dev/null +++ b/spring-credhub-core/src/main/java/org/springframework/credhub/support/ssh/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Java representations of CredHub SSH credentials. + */ +package org.springframework.credhub.support.ssh; \ No newline at end of file diff --git a/spring-credhub-core/src/main/java/org/springframework/credhub/support/user/package-info.java b/spring-credhub-core/src/main/java/org/springframework/credhub/support/user/package-info.java new file mode 100644 index 0000000..1c64ddb --- /dev/null +++ b/spring-credhub-core/src/main/java/org/springframework/credhub/support/user/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Java representations of CredHub user credentials. + */ +package org.springframework.credhub.support.user; \ No newline at end of file diff --git a/spring-credhub-core/src/main/java/org/springframework/credhub/support/value/package-info.java b/spring-credhub-core/src/main/java/org/springframework/credhub/support/value/package-info.java new file mode 100644 index 0000000..c42bd32 --- /dev/null +++ b/spring-credhub-core/src/main/java/org/springframework/credhub/support/value/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Java representations of CredHub value credentials. + */ +package org.springframework.credhub.support.value; \ No newline at end of file