diff --git a/src/main/java/de/stklcode/jvault/connector/builder/package-info.java b/src/main/java/de/stklcode/jvault/connector/builder/package-info.java new file mode 100644 index 0000000..1a51c4a --- /dev/null +++ b/src/main/java/de/stklcode/jvault/connector/builder/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright 2016-2018 Stefan Kalscheuer + * + * 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. + */ + +/** + * This package contains the {@link de.stklcode.jvault.connector.builder.VaultConnectorBuilder} to initialize a + * connector instance. + */ +package de.stklcode.jvault.connector.builder; diff --git a/src/main/java/de/stklcode/jvault/connector/exception/package-info.java b/src/main/java/de/stklcode/jvault/connector/exception/package-info.java new file mode 100644 index 0000000..edc7c76 --- /dev/null +++ b/src/main/java/de/stklcode/jvault/connector/exception/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2018 Stefan Kalscheuer + * + * 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. + */ + +/** + * Some custom exceptions for error handling. + */ +package de.stklcode.jvault.connector.exception; diff --git a/src/main/java/de/stklcode/jvault/connector/factory/package-info.java b/src/main/java/de/stklcode/jvault/connector/factory/package-info.java new file mode 100644 index 0000000..c6ca5d4 --- /dev/null +++ b/src/main/java/de/stklcode/jvault/connector/factory/package-info.java @@ -0,0 +1,23 @@ +/* + * Copyright 2016-2018 Stefan Kalscheuer + * + * 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. + */ + +/** + * This package contains the {@link de.stklcode.jvault.connector.factory.VaultConnectorFactory} to initialize a + * connector instance. + * + * @deprecated As of v0.8.0 please refer to {@link de.stklcode.jvault.connector.builder}. + */ +package de.stklcode.jvault.connector.factory; diff --git a/src/main/java/de/stklcode/jvault/connector/model/package-info.java b/src/main/java/de/stklcode/jvault/connector/model/package-info.java new file mode 100644 index 0000000..1fe9b9d --- /dev/null +++ b/src/main/java/de/stklcode/jvault/connector/model/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2018 Stefan Kalscheuer + * + * 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. + */ + +/** + * Model classes for communication with the Vault API. + */ +package de.stklcode.jvault.connector.model; diff --git a/src/main/java/de/stklcode/jvault/connector/model/response/embedded/package-info.java b/src/main/java/de/stklcode/jvault/connector/model/response/embedded/package-info.java new file mode 100644 index 0000000..3e155d5 --- /dev/null +++ b/src/main/java/de/stklcode/jvault/connector/model/response/embedded/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2018 Stefan Kalscheuer + * + * 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. + */ + +/** + * Embedded data classes for responses from the Vault API. + */ +package de.stklcode.jvault.connector.model.response.embedded; diff --git a/src/main/java/de/stklcode/jvault/connector/model/response/package-info.java b/src/main/java/de/stklcode/jvault/connector/model/response/package-info.java new file mode 100644 index 0000000..0e312ce --- /dev/null +++ b/src/main/java/de/stklcode/jvault/connector/model/response/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2016-2018 Stefan Kalscheuer + * + * 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. + */ + +/** + * Model classes for responses from the Vault API. + */ +package de.stklcode.jvault.connector.model.response; diff --git a/src/main/java/de/stklcode/jvault/connector/package-info.java b/src/main/java/de/stklcode/jvault/connector/package-info.java new file mode 100644 index 0000000..142b97b --- /dev/null +++ b/src/main/java/de/stklcode/jvault/connector/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright 2016-2018 Stefan Kalscheuer + * + * 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 Vault Connector base package - contains {@link de.stklcode.jvault.connector.VaultConnector} interface and + * default implementation. + */ +package de.stklcode.jvault.connector; diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html new file mode 100644 index 0000000..9aec4a4 --- /dev/null +++ b/src/main/javadoc/overview.html @@ -0,0 +1,13 @@ + + + + + API Overview + + +

Java Vault Connector is a connector library for Vault by Hashicorp written in Java.

+

The connector allows simple usage of Vault's secret store in own applications.

+

It features a default implementation for the HTTP(S) interface and supports various authorization methods including + AppRole, token and secret handling.

+ +