You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@syncope.apache.org by ma...@apache.org on 2015/12/01 15:23:56 UTC
[1/3] syncope git commit: Wrong resource command messages, SYNCOPE-158
Repository: syncope
Updated Branches:
refs/heads/master 933fcc68f -> 08531e6e6
Wrong resource command messages, SYNCOPE-158
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/b9f542bf
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/b9f542bf
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/b9f542bf
Branch: refs/heads/master
Commit: b9f542bf26702f3823168fa86ac8955d50341583
Parents: 933fcc6
Author: massi <ma...@tirasa.net>
Authored: Tue Dec 1 14:56:56 2015 +0100
Committer: massi <ma...@tirasa.net>
Committed: Tue Dec 1 14:56:56 2015 +0100
----------------------------------------------------------------------
.../syncope/client/cli/commands/resource/ResourceDetails.java | 2 +-
client/cli/src/main/resources/messages.properties | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/b9f542bf/client/cli/src/main/java/org/apache/syncope/client/cli/commands/resource/ResourceDetails.java
----------------------------------------------------------------------
diff --git a/client/cli/src/main/java/org/apache/syncope/client/cli/commands/resource/ResourceDetails.java b/client/cli/src/main/java/org/apache/syncope/client/cli/commands/resource/ResourceDetails.java
index 5d0f90b..be0029c 100644
--- a/client/cli/src/main/java/org/apache/syncope/client/cli/commands/resource/ResourceDetails.java
+++ b/client/cli/src/main/java/org/apache/syncope/client/cli/commands/resource/ResourceDetails.java
@@ -44,7 +44,7 @@ public class ResourceDetails extends AbstractResourceCommand {
try {
final Map<String, String> details = new LinkedMap<>();
final List<ResourceTO> resourceTOs = resourceSyncopeOperations.list();
- details.put("Total numbers", String.valueOf(resourceTOs.size()));
+ details.put("Total number", String.valueOf(resourceTOs.size()));
resourceResultManager.printDetails(details);
} catch (final SyncopeClientException ex) {
LOG.error("Error reading details about resource", ex);
http://git-wip-us.apache.org/repos/asf/syncope/blob/b9f542bf/client/cli/src/main/resources/messages.properties
----------------------------------------------------------------------
diff --git a/client/cli/src/main/resources/messages.properties b/client/cli/src/main/resources/messages.properties
index dd9bc2f..934cba0 100644
--- a/client/cli/src/main/resources/messages.properties
+++ b/client/cli/src/main/resources/messages.properties
@@ -26,7 +26,7 @@ policy.help.message=\nUsage: policy [options]\n Options:\n --help \n --de
question.help.message=\nUsage: question [options]\n Options:\n --help \n --list \n --read \n Syntax: --read {QUESTION-ID} {QUESTION-ID} [...]\n --delete \n Syntax: --delete {QUESTION-ID} {QUESTION-ID} [...]\n
realm.help.message=\nUsage: realm [options]\n Options:\n --help \n --details \n --list \n
report.help.message=\nUsage: report [options]\n Options:\n --help \n --details\n --list \n --list-jobs \n --read \n Syntax: --read {REPORT-ID} {REPORT-ID} [...] \n --delete \n Syntax: --delete {REPORT-ID} {REPORT-ID} [...]\n --execute \n Syntax: --execute {REPORT-ID} \n --read-execution \n Syntax: --read-execution {EXECUTION-ID} {EXECUTION-ID} [...]\n --delete-execution \n Syntax: --delete-execution {EXECUTION-ID} {EXECUTION-ID} [...]\n --export-execution-result \n Syntax: --export-execution-result {EXECUTION-ID} {EXECUTION-ID} [...] {FORMAT}\n Format: CSV / HTML / PDF / XML / RTF\n
-resource.help.message=\nUsage: resource [options]\n Options:\n --help \n --details \n --list \n --read \n Syntax: --read {CONNECTOR-ID} {CONNECTOR-ID} [...]\n --delete \n Syntax: --delete {CONNECTOR-ID} {CONNECTOR-ID} [...]\n
+resource.help.message=\nUsage: resource [options]\n Options:\n --help \n --details \n --list \n --read \n Syntax: --read {RESOURCE-NAME} {RESOURCE-NAME} [...]\n --delete \n Syntax: --delete {RESOURCE-NAME} {RESOURCE-NAME} [...]\n
role.help.message=\nUsage: role [options]\n Options:\n --help \n --details \n --list \n --read \n Syntax: --read {ROLE-ID} {ROLE-ID} [...]\n --delete \n Syntax: --delete {ROLE-ID} {ROLE-ID} [...]\n
schema.help.message=\nUsage: schema [options]\n Options:\n --help \n --details \n --list-all\n --list-plain\n --list-derived\n --list-virtual\n --read {SCHEMA-TYPE} {SCHEMA-KEY}\n Schema type: PLAIN / DERIVED / VIRTUAL\n --delete {SCHEMA-TYPE} {SCHEMA-KEY}\n Schema type: PLAIN / DERIVED / VIRTUAL\n
task.help.message=\nUsage: task [options]\n Options:\n --help \n --details\n --list\n Syntax: --list {TASK-TYPE} \n Task type: NOTIFICATION / PROPAGATION / PUSH / SCHEDULED / SYNCHRONIZATION\n --list-running-jobs \n --list-scheduled-jobs \n --read \n Syntax: --read {TASK-ID} {TASK-ID} [...]\n --read-execution \n Syntax: --read-execution {TASK-EXEC-ID} {TASK-EXEC-ID} [...]\n --delete \n Syntax: --delete {TASK-ID} {TASK-ID} [...]\n --delete-execution \n Syntax: --delete-execution {TASK-EXEC-ID} {TASK-EXEC-ID} [...]\n --execute \n Syntax: --execute {TASK-ID} {DRY-RUN}\n Dry run: true / false\n
[3/3] syncope git commit: cli docs: policy, SYNCOPE-722
Posted by ma...@apache.org.
cli docs: policy, SYNCOPE-722
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/08531e6e
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/08531e6e
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/08531e6e
Branch: refs/heads/master
Commit: 08531e6e604815c9b1a134a83b5e118f938f460c
Parents: 394aa2e
Author: massi <ma...@tirasa.net>
Authored: Tue Dec 1 15:08:23 2015 +0100
Committer: massi <ma...@tirasa.net>
Committed: Tue Dec 1 15:08:23 2015 +0100
----------------------------------------------------------------------
src/main/asciidoc/cli-policy.adoc | 168 +++++++++++++++++++++++++++++++++
src/main/asciidoc/cli.adoc | 4 +-
2 files changed, 171 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/08531e6e/src/main/asciidoc/cli-policy.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-policy.adoc b/src/main/asciidoc/cli-policy.adoc
new file mode 100644
index 0000000..c3f0a5d
--- /dev/null
+++ b/src/main/asciidoc/cli-policy.adoc
@@ -0,0 +1,168 @@
+//
+// 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 serves to retrieve the 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} [...]
+----
+
+===== Details option
+This option shows a table with policies amount for each type.
+
+[source]
+--
+$ ./syncopeadm.sh policy --details
+--
+
+[source]
+--
+
+You are runnig: policy --details
+
+#################################
+# #
+# POLICIES DETAILS #
+# #
+#################################
+# # #
+# DETAIL # VALUE #
+# # #
+#################################
+# # #
+# total number # 9 #
+# account policies # 2 #
+# password policies # 3 #
+# sync policies # 4 #
+# push policies # 0 #
+# # #
+#################################
+
+--
+
+===== List option
+Running the command with this option you will see the list of the policies.
+
+[source]
+--
+$ ./syncopeadm.sh Usage: policy --list {POLICY-TYPE}
+ Policy type: ACCOUNT / PASSWORD / SYNC / PUSH
+--
+
+[source]
+--
+
+./syncopeadm.sh policy --list SYNC
+
+You are runnig: policy --list SYNC
+
+ > KEY: 1
+ type: SYNC
+ description: a sync policy
+ resources : []
+ realms : []
+
+ > KEY: 3
+ type: SYNC
+ description: sync policy 2
+ resources : [resource-csv]
+ realms : []
+ conflict resolution action: ALL
+ correlation rule : {USER=["username","firstname"]}
+
+ > KEY: 7
+ type: SYNC
+ description: sync policy 1
+ resources : []
+ realms : []
+ conflict resolution action: IGNORE
+ correlation rule : {}
+
+ > KEY: 9
+ type: SYNC
+ description: sync policy for java rule
+ resources : [ws-target-resource-2]
+ realms : []
+ conflict resolution action: IGNORE
+ correlation rule : {}
+
+--
+
+===== Read option
+The option to read all the information of specified policy.
+
+[source]
+--
+$ ./syncopeadm.sh policy --read {POLICY-ID} {POLICY-ID} [...]
+--
+
+Unlike the list option, the read one shows only the policy passed as input.
+[source]
+--
+You are runnig: policy --read 6
+
+ > KEY: 6
+ type: ACCOUNT
+ description: sample account policy
+ resources : []
+ realms : [/odd]
+ max authentication attempts : 3
+ propagation suspension : false
+ RULES :
+ > class : [org.apache.syncope.common.lib.policy.DefaultAccountRuleConf@708a538f[
+ maxLength=0
+ minLength=4
+ pattern=<null>
+ allUpperCase=false
+ allLowerCase=false
+ wordsNotPermitted=[]
+ schemasNotPermitted=[]
+ prefixesNotPermitted=[notpermitted1, notpermitted2]
+ suffixesNotPermitted=[]
+ name=org.apache.syncope.common.lib.policy.DefaultAccountRuleConf
+]]
+--
+
+===== Delete option
+The option to delete a specified policy.
+
+[source]
+--
+$ ./syncopeadm.sh policy --delete {POLICY-ID} {POLICY-ID} [...]
+--
+
+The delete option, as can be imagined, tries to remove a specified policy.
+The output will be something like:
+[source]
+--
+ - Policy {POLICY-ID} successfully deleted
+--
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/08531e6e/src/main/asciidoc/cli.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli.adoc b/src/main/asciidoc/cli.adoc
index 3596cd1..7f284e7 100644
--- a/src/main/asciidoc/cli.adoc
+++ b/src/main/asciidoc/cli.adoc
@@ -42,4 +42,6 @@ include::cli-user.adoc[]
include::cli-report.adoc[]
-include::cli-resource.adoc[]
\ No newline at end of file
+include::cli-resource.adoc[]
+
+include::cli-policy.adoc[]
\ No newline at end of file
[2/3] syncope git commit: cli docs: resource, SYNCOPE-722
Posted by ma...@apache.org.
cli docs: resource, SYNCOPE-722
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/394aa2e8
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/394aa2e8
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/394aa2e8
Branch: refs/heads/master
Commit: 394aa2e80f1009dbc2657d56d06a39d5b21fea49
Parents: b9f542b
Author: massi <ma...@tirasa.net>
Authored: Tue Dec 1 14:57:06 2015 +0100
Committer: massi <ma...@tirasa.net>
Committed: Tue Dec 1 14:57:06 2015 +0100
----------------------------------------------------------------------
src/main/asciidoc/cli-resource.adoc | 208 +++++++++++++++++++++++++++++++
src/main/asciidoc/cli.adoc | 4 +-
2 files changed, 211 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/394aa2e8/src/main/asciidoc/cli-resource.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-resource.adoc b/src/main/asciidoc/cli-resource.adoc
new file mode 100644
index 0000000..61c760d
--- /dev/null
+++ b/src/main/asciidoc/cli-resource.adoc
@@ -0,0 +1,208 @@
+//
+// 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 serves to retrieve the 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} [...]
+----
+
+===== Details option
+This option shows a table with resource amount.
+
+[source]
+--
+$ ./syncopeadm.sh resource --details
+--
+
+[source]
+--
+
+You are runnig: resource --details
+
+#############################
+# #
+# RESOURCES DETAILS #
+# #
+#############################
+# # #
+# DETAIL # VALUE #
+# # #
+#############################
+# # #
+# Total numbers # 19 #
+# # #
+#############################
+
+--
+
+Total number::
+ number of resources;
+
+===== List option
+Running the command with this option you will see the list of the resources.
+
+[source]
+--
+$ ./syncopeadm.sh resource --list
+--
+
+[source]
+--
+
+You are runnig: resource --list
+
+ > RESOURCE ID: ws-target-resource-1
+ connector dispaly name: ConnInstance100
+ etag value: 1287565200000
+ connector id: 100
+ account policy id: null
+ password policy id: null
+ sync policy id: null
+ creator: admin
+ creation date: Wed Oct 20 11:00:00 CEST 2010
+ last modifier: admin
+ last change date: Wed Oct 20 11:00:00 CEST 2010
+ propagation actions class: []
+ propagation priority: 1
+ PROVISIONS:
+ provision id: 15
+ any type: USER
+ object class: __ACCOUNT__
+ sync token: null
+ virtual schema: []
+ MAPPING:
+ ConnObjectLink: null
+ MAPPING ITEM:
+ mapping key: 99
+ mapping item type: UserKey
+ internal attribute name: id
+ external attribute name: userId
+ mandatory condition: true
+ transformers class: []
+ purpose: PROPAGATION
+ connector object key: true
+ password: false
+
+ mapping key: 100
+ mapping item type: UserPlainSchema
+ internal attribute name: email
+ external attribute name: email
+ mandatory condition: true
+ transformers class: []
+ purpose: PROPAGATION
+ connector object key: false
+ password: false
+
+ mapping key: 101
+ mapping item type: UserPlainSchema
+ internal attribute name: surname
+ external attribute name: surname
+ mandatory condition: true
+ transformers class: []
+ purpose: PROPAGATION
+ connector object key: false
+ password: false
+
+ mapping key: 102
+ mapping item type: Password
+ internal attribute name: password
+ external attribute name: __PASSWORD__
+ mandatory condition: true
+ transformers class: []
+ purpose: PROPAGATION
+ connector object key: false
+ password: true
+
+ mapping key: 335
+ mapping item type: UserPlainSchema
+ internal attribute name: surname
+ external attribute name: fullname
+ mandatory condition: true
+ transformers class: []
+ purpose: PROPAGATION
+ connector object key: false
+ password: false
+
+ mapping key: 336
+ mapping item type: UserPlainSchema
+ internal attribute name: type
+ external attribute name: type
+ mandatory condition: true
+ transformers class: []
+ purpose: PROPAGATION
+ connector object key: false
+ password: false
+
+ mapping key: 337
+ mapping item type: UserPlainSchema
+ internal attribute name: firstname
+ external attribute name: name
+ mandatory condition: false
+ transformers class: []
+ purpose: NONE
+ connector object key: false
+ password: false
+
+ create trace level: ALL
+ delete trace level: ALL
+ update trace level: ALL
+ sync trace level: ALL
+ enforce mandatory condition: false
+ override capabilities: false
+ random password if not provided: false
+[...]
+
+--
+
+===== Read option
+The option to read all the information of specified resource.
+
+[source]
+--
+$ ./syncopeadm.sh resource --read {RESOURCE-NAME} {RESOURCE-NAME} [...]
+--
+
+Unlike the list option, the read one shows only the resources passed as input.
+
+===== Delete option
+The option to delete a specified resource.
+
+[source]
+--
+$ ./syncopeadm.sh resource --delete {RESOURCE-NAME} {RESOURCE-NAME} [...]
+--
+
+The delete option, as can be imagined, tries to remove a specified resources.
+The output will be something like:
+[source]
+--
+ - Resource {RESOURCE-NAME} successfully deleted
+--
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/394aa2e8/src/main/asciidoc/cli.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli.adoc b/src/main/asciidoc/cli.adoc
index 1e15c57..3596cd1 100644
--- a/src/main/asciidoc/cli.adoc
+++ b/src/main/asciidoc/cli.adoc
@@ -40,4 +40,6 @@ include::cli-schema.adoc[]
include::cli-user.adoc[]
-include::cli-report.adoc[]
\ No newline at end of file
+include::cli-report.adoc[]
+
+include::cli-resource.adoc[]
\ No newline at end of file