Repository: syncope Updated Branches: refs/heads/2_0_NO_JAXB f283ebc0c -> 480387d68 (forced update)
http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/installation.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/installation.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/installation.adoc deleted file mode 100644 index fb7e693..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/installation.adoc +++ /dev/null @@ -1,181 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Installation command -The installation process creates a file, called _cli.properties_, used by the script to call the Apache Syncope -REST API services with the right credentials. - -The properties file will contain content similar to: - -* *syncope.rest.services*=http://localhost:9080/syncope/rest -* *syncope.admin.user*=admin -* *syncope.admin.password*=QePSFVTnzwQowM4ohhaUYcE6aW47MVZ/ - -where the properties are: - -syncope.rest.services:: - the URL where the Apache Syncope REST API services are listening; -syncope.admin.user:: - the user with the permission to call the Syncope APIs; -syncope.admin.password:: - the user password; - -as can be seen, the user password is encrypted. This is only to avoid that another user could -read an admin password. - -===== Help message -[source,bash] ----- -Usage: install [options] - Options: - --help - --setup - --setup-debug ----- - -===== Run the installation -After the zip file is unzipped you can start with CLI client using the syncopeadm file. -If you tried to run a CLI command before the installation process, the script returns -[source] --- - - Error: It seems you need to first setup the CLI client. Run install --setup. --- - -So, as suggested, you have to run the install command to use the CLI: -[source] --- -$ ./syncopeadm.sh install --setup --- - -A successful result will be: -[source,bash,subs="verbatim,attributes"] ----- - -You are running: install --setup - -############################################### -# # -# Welcome to Syncope CLI installation process # -# # -############################################### - -Path to config files of Syncope CLI client will be: ./ -- File system permission checked - -Syncope server schema [http/https]: http -Syncope server hostname [e.g. localhost]: localhost -Syncope server port [e.g. 8080]: 9080 -Syncope server rest context [e.g. /syncope/rest/]: /syncope/rest -Syncope admin user: admin -Syncope admin password: password -Installation parameters checked on Syncope core version: {docVersion} - -############################################### -# # -# Installation successful # -# now you can use Syncope CLI client # -# # -############################################### - ----- - -During the installation you have to provide: - -Syncope server schema:: - the http protocol used by the Apache Syncope core, it will be http or https; -Syncope server hostname:: - the hostname where the core is deployed; -Syncope server port:: - the port where the services are listening; -Syncope server rest context:: - the context where the rest services are deployed (/syncope/rest is the default); -Syncope admin user:: - the user with the permission to call the Syncope APIs; -Syncope admin password:: - the user password. - -===== Installation error -Various error messages are possible on installation. Here are some sample error messages: - -* Syncope unreachable (or wrong address): - -[source] --- - -Provided address :http://localhost:9080/syncope/rest - -############################################### -# # -# Provided address is unreachable! # -# Check it and if it is wrong # -# START the installation AGAIN! # -# # -############################################### - --- - -* Authentication failed: - -[source] --- - -############################################### -# # -# Username or password provided are wrong # -# START the installation AGAIN! # -# # -############################################### - --- - -As the message suggests you have to start the installation again when this error occurrs. - - -===== Debug installation -To work with the debug environment provided by Syncope we added a particular installation option for it. -It enough to run the script with the --setup-debug option -[source] --- -$ ./syncopeadm.sh install --setup-debug --- -[source,bash,subs="verbatim,attributes"] ----- - -You are running: install --setup-debug - -############################################### -# # -# Welcome to Syncope CLI installation process # -# # -############################################### - -Path to config files of Syncope CLI client will be: ./ -- File system permission checked - -Installation parameters checked on Syncope core version: {docVersion} - -############################################### -# # -# Installation successful # -# now you can use Syncope CLI client # -# # -############################################### - ----- - http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/introduction.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/introduction.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/introduction.adoc deleted file mode 100644 index 76960bf..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/introduction.adoc +++ /dev/null @@ -1,33 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Introduction -A brief introduction about this document and the examples you will find reading it. - -Once you have downloaded and unzipped the zip file containing the scripts, you will find a lib directory and -two script files, a .bat and a .sh one, called _syncopeadm_. You will use one of these files, depending on your operating system. - -[NOTE] -Every example described in this document is executed on a linux machine with a _debug environment_. - -[NOTE] -Wikipedia suggests that a https://en.wikipedia.org/wiki/Command-line_interface[command line interface] (CLI) -is a means of interacting with a computer program, where the user (or client) issues commands to the program -in the form of successive lines of text (command lines). In our case the CLI tool is the way to call, more or less, -every Syncope core command through a shell. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/logger.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/logger.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/logger.adoc deleted file mode 100644 index edde628..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/logger.adoc +++ /dev/null @@ -1,59 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Logger command -The logger command retrieves information about the logger configuration in Apache Syncope. - -===== Help message -[source,bash] ----- -Usage: logger [options] - Options: - --help - --details - --list - --read - Syntax: --read {LOG-NAME} {LOG-NAME} [...] - --update - Syntax: --update {LOG-NAME}={LOG-LEVEL} {LOG-NAME}={LOG-LEVEL} [...] - --update-all - Syntax: --update-all {LOG-LEVEL} - --create - Syntax: --create {LOG-NAME}={LOG-LEVEL} {LOG-NAME}={LOG-LEVEL} [...] - --delete - Syntax: --delete {LOG-NAME} {LOG-NAME} [...] ----- - -===== Options - ---details:: -This option shows a table with some details about logger configuration. ---list:: -Running the command with this option you will see the table of the loggers configuration. ---read:: -The option to read all the information of specified loggers. ---update:: -The option to change the value of the logger passed as input. ---update-all:: -This option is especially helpful in production environment when every log is disabled and you need to change them for a -while in DEBUG mode. ---create:: -For the moment the logger command is one of the few command with a create option to add a new logger configuration. ---delete:: -The option to delete a specified logger. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/notification.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/notification.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/notification.adoc deleted file mode 100644 index da9e4a9..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/notification.adoc +++ /dev/null @@ -1,43 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Notification command -The notification command retrieves information about the configured notifications. - -===== Help message -[source,bash] ----- -Usage: notification [options] - Options: - --help - --list - --read - Syntax: --read {NOTIFICATION-ID} - --delete - Syntax: --delete {NOTIFICATION-ID} ----- - -===== Options - ---list:: -Running the command with this option you will see the list of notificaitons with their configuration. ---read:: -The option to read all the information of the specified notifications. ---delete:: -The option to delete a specified notification. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/policy.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/policy.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/policy.adoc deleted file mode 100644 index 5de2e24..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/policy.adoc +++ /dev/null @@ -1,48 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Policy command -The policy command retrieves information about the policies for each type. - -===== Help message -[source,bash] ----- -Usage: policy [options] - Options: - --help - --details - --list - Syntax: --list-policy {POLICY-TYPE} - Policy type: ACCOUNT / PASSWORD / SYNC / PUSH - --read - Syntax: --read {POLICY-ID} {POLICY-ID} [...] - --delete - Syntax: --delete {POLICY-ID} {POLICY-ID} [...] ----- - -===== Options - ---details:: -This option shows a table with the amount of policies for each type. ---list:: -Running the command with this option you will see the list of the policies. ---read:: -The option to read all the information of a specified policy. ---delete:: -The option to delete a specified policy. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/question.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/question.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/question.adoc deleted file mode 100644 index 4a1a261..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/question.adoc +++ /dev/null @@ -1,43 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Question command -The question command gets information about the user question to retrieve their password. - -===== Help message -[source,bash] ----- -Usage: question [options] - Options: - --help - --list - --read - Syntax: --read {QUESTION-ID} {QUESTION-ID} [...] - --delete - Syntax: --delete {QUESTION-ID} {QUESTION-ID} [...] ----- - -===== Options - ---list:: -Running the command with this option you will see the list of questions with their content. ---read:: -The option to read all the information of specified questions. ---delete:: -The option to delete a specified question. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/realm.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/realm.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/realm.adoc deleted file mode 100644 index d091865..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/realm.adoc +++ /dev/null @@ -1,38 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Realm command -The realm command retrieves information about the configured realm. - -===== Help message -[source,bash] ----- -Usage: realm [options] - Options: - --help - --details - --list ----- - -===== Options - ---details:: -This option shows a table with the amount of the available realms. ---list:: -Running the command with this option you will see the list of the realms. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/report.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/report.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/report.adoc deleted file mode 100644 index 8f8d472..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/report.adoc +++ /dev/null @@ -1,66 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Report command -The report command retrieves information about the configured reports. - -===== Help message -[source,bash] ----- -Usage: report [options] - Options: - --help - --details - --list - --list-jobs - --read - Syntax: --read {REPORT-ID} {REPORT-ID} [...] - --delete - Syntax: --delete {REPORT-ID} {REPORT-ID} [...] - --execute - Syntax: --execute {REPORT-ID} - --read-execution - Syntax: --read-execution {EXECUTION-ID} {EXECUTION-ID} [...] - --delete-execution - Syntax: --delete-execution {EXECUTION-ID} {EXECUTION-ID} [...] - --export-execution-result - Syntax: --export-execution-result {EXECUTION-ID} {EXECUTION-ID} [...] {FORMAT} - Format: CSV / HTML / PDF / XML / RTF ----- - -===== Options - ---details:: -This option shows a table with some details about the reports and their executions. ---list:: -Running the command with this option you will see the list of configured reports. ---list-jobs:: -Running the command with this option you will see the list of the report executions. ---read:: -The option to read all the information of a specified report. ---read-execution:: -The option to read all the information of a specified report execution. ---delete:: -The option to delete a specified report. ---delete-execution:: -The option to delete a specified report execution. ---execute:: -The option to run a report. ---export-execution-result:: -The option to export an execution in a certain format to see the results. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/resource.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/resource.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/resource.adoc deleted file mode 100644 index 367c84f..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/resource.adoc +++ /dev/null @@ -1,46 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Resource command -The resource command retrieves information about the resources. - -===== Help message -[source,bash] ----- -Usage: resource [options] - Options: - --help - --details - --list - --read - Syntax: --read {RESOURCE-NAME} {RESOURCE-NAME} [...] - --delete - Syntax: --delete {RESOURCE-NAME} {RESOURCE-NAME} [...] ----- - -===== Options - ---details:: -This option shows a table with amount of available resources. ---list:: -Running the command with this option you will see the list of resources. ---read:: -The option to read all the information of a specified resource. ---delete:: -The option to delete a specified resource. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/role.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/role.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/role.adoc deleted file mode 100644 index c1e6d7b..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/role.adoc +++ /dev/null @@ -1,46 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Role command -The role command retrieves information about the roles. - -===== Help message -[source,bash] ----- -Usage: role [options] - Options: - --help - --details - --list - --read - Syntax: --read {ROLE-NAME} {ROLE-NAME} [...] - --delete - Syntax: --delete {ROLE-NAME} {ROLE-NAME} [...] ----- - -===== Options - ---details:: -This option shows a table with some details about the roles. ---list:: -Running the command with this option you will see the list of roles with the realm where they are configured and their entitlments. ---read:: -The option to read all the information of specified roles. ---delete:: -The option to delete specified roles. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/schema.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/schema.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/schema.adoc deleted file mode 100644 index 8b18b72..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/schema.adoc +++ /dev/null @@ -1,56 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Schema command -The schema command serves retrieves information about the schema categories. - -===== Help message -[source,bash] ----- -Usage: schema [options] - Options: - --help - --details - --list-all - --list-plain - --list-derived - --list-virtual - --read {SCHEMA-TYPE} {SCHEMA-KEY} - Schema type: PLAIN / DERIVED / VIRTUAL - --delete {SCHEMA-TYPE} {SCHEMA-KEY} - Schema type: PLAIN / DERIVED / VIRTUAL ----- - -===== Options - ---details:: -This option shows a table with some details about the schemas and their categories. ---list-all:: -Running the command with this option you will see the list of all (PLAIN, DERIVED, VIRTUAL) schemas configured. ---list-plain:: -Running the command with this option you will see the list of the plain schemas available in Syncope. ---list-derived:: -Running the command with this option you will see the list of the derived schemas available in Syncope with -their expressions. ---list-virtual:: -Running the command with this option you will see the list of the virtual schemas available in Syncope. ---read:: -The option to read all the information of a specified schema. ---delete:: -The option to delete a specified schema. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/task.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/task.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/task.adoc deleted file mode 100644 index 9889956..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/task.adoc +++ /dev/null @@ -1,67 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Task command -The Task command retrieves information about the Task configuration in Apache Syncope. - -===== Help message -[source,bash] ----- -Usage: task [options] - Options: - --help - --details - --list - Syntax: --list {TASK-TYPE} - Task type: NOTIFICATION / PROPAGATION / PUSH / SCHEDULED / PULL - --list-running-jobs - --list-scheduled-jobs - --read - Syntax: --read {TASK-ID} {TASK-ID} [...] - --read-execution - Syntax: --read-execution {TASK-EXEC-ID} {TASK-EXEC-ID} [...] - --delete - Syntax: --delete {TASK-ID} {TASK-ID} [...] - --delete-execution - Syntax: --delete-execution {TASK-EXEC-ID} {TASK-EXEC-ID} [...] - --execute - Syntax: --execute {TASK-ID} {DRY-RUN} - Dry run: true / false ----- - -===== Options - ---details:: -This option shows a table with some details about tasks and jobs. ---list:: -Running the command with this option you will see the list of selected tasks type with their information. ---list-scheduled-jobs:: -Running the command with this option you will see the list of the actual scheduled jobs. ---list-running-jobs:: -Running the command with this option you will see the list of the actual runnig jobs. ---read:: -The option to read all the information of a task. ---read-execution:: -The option to read all the information of executions task. ---delete:: -The option to delete specified tasks. ---delete-execution:: -The option to delete specified execution tasks. ---execute:: -The option to execute specified execution tasks. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/user.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/user.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/user.adoc deleted file mode 100644 index 30fd6fd..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/user.adoc +++ /dev/null @@ -1,79 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== User command -The user command retrieves information about the users. - -===== Help message -[source,bash] ----- -Usage: user [options] - Options: - --help - --list - --details - --get-user-key - Syntax: --get-user-key {USERNAME} {USERNAME} [...] - --get-username - Syntax: --get-username {USER-ID} {USER-ID} [...] - --read-by-usernam - Syntax: --read-by-usernam {USERNAME} {USERNAME} [...] - --read-by-userid - Syntax: --read-by-userid {USER-ID} {USER-ID} [...] - --search-by-attribute - Syntax: --search-by-attribute {REALM} {ATTR-NAME}={ATTR-VALUE} - --search-by-role - Syntax: --search-by-role {REALM} {ROLE-ID} - --search-by-resource - Syntax: --search-by-resource {REALM} {RESOURCE-NAME} - --delete - Syntax: --delete {USER-ID} {USER-ID} [...] - --delete-all - Syntax: --delete-all {REALM} - --delete-by-attribute - Syntax: --delete-by-attribute {REALM} {ATTR-NAME}={ATTR-VALUE} ----- - -===== Options - ---details:: -This option shows a table with some details about the users. --- List option:: -Running the command with this option you will see the list of all users in the environment. However, the system will -ask you a confirmation before execution, because as you can imagine this operation might produce very large output. ---get-user-key:: -The option to get the user key starting from a username. ---get-username:: -The option to get the username starting from a user id. ---read-by-userid:: -The option to read user information by their user id. ---read-by-usernam:: -The option to read user information by their username. ---search-by-attribute:: -The option to search a list of users with a common attribute. ---search-by-role:: -The option to search a list of users with a specified role. ---search-by-resource:: -The option to search a list of users with a specified resource. ---delete -The option to delete a specified user. ---delete-by-attribute -The option to delete the users with a common attribute. ---delete-all -The option to delete all users of the realm passed as input. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/installation/installation.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/installation/installation.adoc b/src/main/asciidoc/workingwithapachesyncope/installation/installation.adoc deleted file mode 100644 index d4b7741..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/installation/installation.adoc +++ /dev/null @@ -1,23 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// -include::../../commondocs/guiinstaller.adoc[] - -include::../../commondocs/maven.adoc[] - -include::../../commondocs/debpackages.adoc[] http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/installation/maven.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/installation/maven.adoc b/src/main/asciidoc/workingwithapachesyncope/installation/maven.adoc deleted file mode 100644 index 12e6d69..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/installation/maven.adoc +++ /dev/null @@ -1,19 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// -==== Maven \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/restfulservices/client-library.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/restfulservices/client-library.adoc b/src/main/asciidoc/workingwithapachesyncope/restfulservices/client-library.adoc deleted file mode 100644 index 018027e..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/restfulservices/client-library.adoc +++ /dev/null @@ -1,60 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// - -==== Client library -The Apache Syncope client library, as suggested, is a Java client to work with the Apache Syncope core. - -===== Maven dependency -[source,xml,subs="verbatim,attributes"] ----- -<dependency> - <groupId>org.apache.syncope.client</groupId> - <artifactId>syncope-client-lib</artifactId> - <version>{docVersion}</version> -</dependency> ----- - -===== Instantiation -Basically, all you need is to obtain a SyncopeClient instance via the following statement in order -to set the base REST URL and credentials: - -[source,java] ----- -SyncopeClient client = new SyncopeClientFactoryBean(). - setAddress("http://localhost:9080/syncope/rest/";). - create("admin", "password"); ----- - -and you get enabled for any kind of REST service interaction with Apache Syncope. -You can read the http://syncope.apache.org/apidocs/1.2/org/apache/syncope/common/services/package-summary.html[javadoc] -page for a documented list of available REST services in Apache Syncope. - -===== Usage example -Below a snippet that shows how to use the SyncopeClient to update the logger configuration. -[source,java] ----- -SyncopeClient client = new SyncopeClientFactoryBean(). - setAddress("http://localhost:9080/syncope/rest/";). - create("admin", "password"); -LoggerService loggerService = client.getService(LoggerService.class); - -LoggerTO loggerTO = loggerService.read(LoggerType.LOG, "org.apache.syncope.core.connid"); -loggerTO.setLevel(LoggerLevel.DEBUG); -loggerService.update(LoggerType.LOG, loggerTO); ----- http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-reference.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-reference.adoc b/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-reference.adoc deleted file mode 100644 index 3c9c145..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-reference.adoc +++ /dev/null @@ -1,74 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// -==== RESTful reference -If you want to read from the complete descriptive REST reference the URL you need is -[source] --- -http://localhost:9080/syncope/ --- -where you can see all the REST resources with their description, the parameters and the reference to the schema, -so you are able to see which attributes and which type are needed to the every service. -Following the same example as before, below two images to show the REST resources of the logger service and another one -for the reference to the schema: - -image::restReferenceLoggerRead.png[restReferenceLoggerRead] - -image::restReferenceLoggerUpdate.png[restReferenceLoggerUpdate] - -image::restSchemaReferenceLogger.png[restSchemaReferenceLogger] - -===== Swagger UI -From the 2.0 version, Syncope offers also the Swagger UI to work with its services. - -The Swagger installation is really simple because you just add the Maven dependency to your core pom.xml file generated -from the archetype operation; the dependency is: -[source, xml] ----- -<dependency> - <groupId>org.apache.syncope.ext</groupId> - <artifactId>syncope-ext-swagger-ui</artifactId> - <version>${syncope.version}</version> -</dependency> ----- - -The swagger interface is available going to the URL -[source] --- -http://localhost:9080/syncope/swagger/#/ --- - -Reading from the Swagger http://swagger.io/[website] - -.Swagger -**** -Swagger is a simple yet powerful representation of your RESTful API. With the largest ecosystem of API tooling on -the planet, thousands of developers are supporting Swagger in almost every modern programming language and deployment -environment. With a Swagger-enabled API, you get interactive documentation, client SDK generation and discoverability. - -We created Swagger to help fulfill the promise of APIs. Swagger helps companies like Apigee, Getty Images, Intuit, -LivingSocial, McKesson, Microsoft, Morningstar, and PayPal build the best possible services with RESTful APIs. - -Now in version 2.0, Swagger is more enabling than ever. And it's 100% open source software. - -**** - -To be consistent with the example, below the image shows the Swagger UI used to read the configuration -of _org.apache.syncope.core.rest_ - -image::swaggerLoggerRead.png[swaggerLoggerRead] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-services.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-services.adoc b/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-services.adoc deleted file mode 100644 index 758bb74..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-services.adoc +++ /dev/null @@ -1,30 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// -=== RESTful services -The RESTful services is the way how the Syncope core web application receives the input from the clients. -This layer, developed in http://cxf.apache.org/docs/jax-rs.html[Apache CXF 2.0], is usually reachable under the -root context of the deployment. -[source] --- -http://localhost:9080/syncope/rest --- - -include::restful-reference.adoc[] - -include::client-library.adoc[] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc b/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc deleted file mode 100644 index 9dd208e..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc +++ /dev/null @@ -1,48 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you 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. -// -== Installation -There are many ways to install the Apache Syncope components - -* from Maven command line; -* from the Installer; -* from the .deb packages. - -include::installation/installation.adoc[] - -== Working with Apache Syncope - -include::adminconsole/adminconsole.adoc[] - -include::cli/cli.adoc[] - -include::restfulservices/restful-services.adoc[] - -=== Customization - -==== Core - -==== Console - -==== New extensions - -=== Deploying in production - -=== Options - -=== High-Availability \ No newline at end of file
