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 17:01:11 UTC
[1/4] syncope git commit: cli docs: info, entitlement, SYNCOPE-722
Repository: syncope
Updated Branches:
refs/heads/master 08531e6e6 -> 78204b93e
cli docs: info, entitlement, SYNCOPE-722
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/8875e0fd
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/8875e0fd
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/8875e0fd
Branch: refs/heads/master
Commit: 8875e0fda8866d1bb8f8b89523eaa4a8bfc8267a
Parents: 08531e6
Author: massi <ma...@tirasa.net>
Authored: Tue Dec 1 16:38:18 2015 +0100
Committer: massi <ma...@tirasa.net>
Committed: Tue Dec 1 16:38:18 2015 +0100
----------------------------------------------------------------------
src/main/asciidoc/cli-entitlement.adoc | 140 ++++++++++++++++++++++++++++
src/main/asciidoc/cli-info.adoc | 52 +++++++++++
src/main/asciidoc/cli.adoc | 6 +-
3 files changed, 197 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/8875e0fd/src/main/asciidoc/cli-entitlement.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-entitlement.adoc b/src/main/asciidoc/cli-entitlement.adoc
new file mode 100644
index 0000000..c7bc30f
--- /dev/null
+++ b/src/main/asciidoc/cli-entitlement.adoc
@@ -0,0 +1,140 @@
+//
+// 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.
+//
+
+==== Entitlement command
+The entitlement command serves to retrieve the information about the entitlments.
+
+===== Help message
+[source,bash]
+----
+Usage: entitlement [options]
+ Options:
+ --help
+ --list
+ --list-role
+ Syntax: --list-role {ENTITLEMENT-NAME}
+ --read-by-username
+ Syntax: --read-by-username {USERNAME}
+ --read-by-userid
+ Syntax: --read-by-userid {USER-ID}
+ --search-by-role
+ Syntax: --search-by-role {ROLE-ID}
+----
+
+===== List option
+Running the command with this option you will see the list of the entitlements.
+
+[source]
+--
+$ ./syncopeadm.sh entitlement --list
+--
+
+[source]
+--
+
+You are runnig: entitlement --list
+
+- CONNECTOR_READ
+- NOTIFICATION_DELETE
+- ANYTYPE_UPDATE
+- RELATIONSHIPTYPE_UPDATE
+- SCHEMA_CREATE
+[...]
+
+--
+
+===== List role option
+Running the command with this option you will see the list of the roles with a certain entitlement.
+
+[source]
+--
+$ ./syncopeadm.sh entitlement --list
+--
+
+[source]
+--
+
+You are runnig: entitlement --list-role PRINTER_DELETE
+
+ > ROLE ID: Search for realm evenTwo
+ REALMS:
+ - /even/two
+
+ > ROLE ID: User manager
+ REALMS:
+ - /
+
+ > ROLE ID: User reviewer
+ REALMS:
+ - /odd
+ - /even
+
+ > ROLE ID: Other
+ REALMS:
+ - /odd
+
+--
+
+===== Read by username option
+The option to read the entitlements of the username passed as input.
+
+[source]
+--
+$ ./syncopeadm.sh entitlement --read-by-username {USERNAME}
+--
+[source]
+--
+You are runnig: entitlement --read-by-username rossini
+
+- GROUP_READ
+- SCHEMA_READ
+- WORKFLOW_FORM_CLAIM
+--
+
+===== Read by userid option
+The option to read the entitlements of the userid passed as input.
+
+[source]
+--
+$ ./syncopeadm.sh entitlement --read-by-userid {USER-ID}
+--
+[source]
+--
+You are runnig: entitlement --read-by-userid 5
+
+- USER_READ
+- USER_SEARCH
+--
+
+===== Search by role option
+The option to read the entitlements of a certain role.
+
+[source]
+--
+$ ./syncopeadm.sh entitlement --search-by-role {ROLE-ID}
+--
+
+[source]
+--
+You are runnig: entitlement --search-by-role Other
+
+- SCHEMA_READ
+- GROUP_READ
+- WORKFLOW_FORM_CLAIM
+--
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/8875e0fd/src/main/asciidoc/cli-info.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-info.adoc b/src/main/asciidoc/cli-info.adoc
new file mode 100644
index 0000000..2186862
--- /dev/null
+++ b/src/main/asciidoc/cli-info.adoc
@@ -0,0 +1,52 @@
+//
+// 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.
+//
+
+==== Info command
+The info command serves to show some information about the Syncope installation.
+
+===== Help message
+[source,bash]
+----
+Usage: info [options]
+ Options:
+ --version
+ --pwd-reset-allowed
+ --pwd-reset-with-question
+ --self-reg-allowed
+ --provisioning-manager-classes
+ --workflow-adapter-classes
+ --account-rules-classes
+ --connid-locations
+ --reconciliation-filter-builders
+ --logic-actions
+ --mail-templates
+ --mapping-item-transformers
+ --password-rules
+ --propagation-actions
+ --push-actions
+ --push-correlation-actions
+ --reportlets
+ --sync-actions
+ --sync-correlation-rules
+ --task-jobs
+ --validators
+ --password-generator
+ --vir-attr-cache
+ --help
+----
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/8875e0fd/src/main/asciidoc/cli.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli.adoc b/src/main/asciidoc/cli.adoc
index 7f284e7..1b0f4c4 100644
--- a/src/main/asciidoc/cli.adoc
+++ b/src/main/asciidoc/cli.adoc
@@ -44,4 +44,8 @@ include::cli-report.adoc[]
include::cli-resource.adoc[]
-include::cli-policy.adoc[]
\ No newline at end of file
+include::cli-policy.adoc[]
+
+include::cli-info.adoc[]
+
+include::cli-entitlement.adoc[]
\ No newline at end of file
[4/4] syncope git commit: cli docs: realm, group, SYNCOPE-722
Posted by ma...@apache.org.
cli docs: realm, group, SYNCOPE-722
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/78204b93
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/78204b93
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/78204b93
Branch: refs/heads/master
Commit: 78204b93ebb7197b796923704506528cb9fca11c
Parents: 748793c
Author: massi <ma...@tirasa.net>
Authored: Tue Dec 1 16:51:53 2015 +0100
Committer: massi <ma...@tirasa.net>
Committed: Tue Dec 1 16:51:53 2015 +0100
----------------------------------------------------------------------
src/main/asciidoc/cli-group.adoc | 205 ++++++++++++++++++++++++++++++++++
src/main/asciidoc/cli-realm.adoc | 111 ++++++++++++++++++
src/main/asciidoc/cli.adoc | 6 +-
3 files changed, 321 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/78204b93/src/main/asciidoc/cli-group.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-group.adoc b/src/main/asciidoc/cli-group.adoc
new file mode 100644
index 0000000..032b94a
--- /dev/null
+++ b/src/main/asciidoc/cli-group.adoc
@@ -0,0 +1,205 @@
+//
+// 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.
+//
+
+==== Group command
+The group command serves to retrieve the information about the configured groups.
+
+===== Help message
+[source,bash]
+----
+Usage: group [options]
+ Options:
+ --help
+ --details
+ --list
+ --read
+ Syntax: --read {GROUP-ID} {GROUP-ID} [...]
+ --read-attr-by-schema-type {GROUP-ID} {SCHEMA-TYPE}
+ Schema type: PLAIN / DERIVED / VIRTUAL
+ --read-attr-by-schema {GROUP-ID} {SCHEMA-TYPE} {SCHEMA-NAME}
+ Schema type: PLAIN / DERIVED / VIRTUAL
+ --delete
+ Syntax: --delete {GROUP-ID} {GROUP-ID} [...]
+----
+
+===== Details option
+This option shows a table with group amount and some information.
+
+[source]
+--
+$ ./syncopeadm.sh group --details
+--
+
+[source]
+--
+
+You are runnig: group --details
+
+##################################
+# #
+# GROUPS DETAILS #
+# #
+##################################
+# # #
+# DETAIL # VALUE #
+# # #
+##################################
+# # #
+# Total number # 16 #
+# Without resources # 10 #
+# Without attributes # 0 #
+# On root realm # 14 #
+# On the other realm # 2 #
+# # #
+##################################
+
+--
+
+===== List option
+Running the command with this option you will see the list of the groups.
+
+[source]
+--
+$ ./syncopeadm.sh group --list
+--
+
+[source]
+--
+
+You are runnig: group --list
+
+ > GROUP ID: 1
+ name: root
+ type: GROUP
+ realm: /
+ status: null
+ user owner: null
+ group owner: null
+ RESOURCES:
+ PLAIN ATTRIBUTES:
+ - icon: [niceIcon]
+
+ - show: [true]
+
+ - rderived_sx: [sx]
+
+ - rderived_dx: [dx]
+
+ DERIVED ATTRIBUTES:
+ - displayProperty: [niceIcon: true] - is readonly
+
+ - rderiveddata: [sx-dx] - is readonly
+
+ - rderivedschema: [sx-dx] - is readonly
+
+ - rderToBePropagated: [sx-dx] - is readonly
+
+ VIRTUAL ATTRIBUTES:
+[...]
+--
+
+===== Read option
+The option to read the group passed as input.
+
+[source]
+--
+$ ./syncopeadm.sh group --read {GROUP-ID} {GROUP-ID} [...]
+--
+
+[source]
+--
+
+You are runnig: group --read 15
+
+ > GROUP ID: 15
+ name: additional
+ type: GROUP
+ realm: /even
+ status: null
+ user owner: null
+ group owner: null
+ RESOURCES:
+ PLAIN ATTRIBUTES:
+ DERIVED ATTRIBUTES:
+ - displayProperty: [: ] - is readonly
+
+ - rderToBePropagated: [-] - is readonly
+
+ - rderiveddata: [-] - is readonly
+
+ - rderivedschema: [-] - is readonly
+
+ VIRTUAL ATTRIBUTES:
+
+--
+
+===== Read attribute of type option
+The option to read the specified attribute type of the group passed as input.
+
+[source]
+--
+$ ./syncopeadm.sh group --read-attr-by-schema-type {GROUP-ID} {SCHEMA-TYPE}
+ Schema type: PLAIN / DERIVED / VIRTUAL
+--
+
+[source]
+--
+
+You are runnig: group --read-attr-by-schema-type 15 DERIVED
+ - displayProperty: [: ] - is readonly
+
+ - rderToBePropagated: [-] - is readonly
+
+ - rderiveddata: [-] - is readonly
+
+ - rderivedschema: [-] - is readonly
+
+--
+
+===== Read an attribute of type option
+The option to read the specified attribute name of the group passed as input.
+
+[source]
+--
+$ ./syncopeadm.sh group --read-attr-by-schema {GROUP-ID} {SCHEMA-TYPE} {SCHEMA-NAME}
+ Schema type: PLAIN / DERIVED / VIRTUAL
+--
+
+[source]
+--
+
+You are runnig: group --read-attr-by-schema 12 PLAIN title
+ - title: [r12]
+
+--
+
+===== Delete option
+The option to delete a specified group.
+
+[source]
+--
+$ ./syncopeadm.sh group --delete {GROUP-ID} {GROUP-ID} [...]
+--
+
+The delete option, as can be imagined, tries to remove a specified group.
+The output will be something like:
+[source]
+--
+ - Group {GROUP-ID} successfully deleted
+--
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/78204b93/src/main/asciidoc/cli-realm.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-realm.adoc b/src/main/asciidoc/cli-realm.adoc
new file mode 100644
index 0000000..2b6855b
--- /dev/null
+++ b/src/main/asciidoc/cli-realm.adoc
@@ -0,0 +1,111 @@
+//
+// 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 serves to retrieve the information about the configured realm.
+
+===== Help message
+[source,bash]
+----
+Usage: realm [options]
+ Options:
+ --help
+ --details
+ --list
+----
+
+===== Details option
+This option shows a table with realm amount.
+
+[source]
+--
+$ ./syncopeadm.sh realm --details
+--
+
+[source]
+--
+
+You are runnig: realm --details
+
+############################
+# #
+# REALMS DETAILS #
+# #
+############################
+# # #
+# DETAIL # VALUE #
+# # #
+############################
+# # #
+# Total number # 4 #
+# # #
+############################
+
+--
+
+===== List option
+Running the command with this option you will see the list of the realms.
+
+[source]
+--
+$ ./syncopeadm.sh realm --list
+--
+
+[source]
+--
+
+You are runnig: realm --list
+
+ > REALM ID: 1
+ name: /
+ full path: /
+ actions: []
+ templates: {}
+ parent id: 0
+ account policy id: null
+ password policy id: 4
+
+ > REALM ID: 2
+ name: odd
+ full path: /odd
+ actions: []
+ templates: {}
+ parent id: 1
+ account policy id: 6
+ password policy id: 4
+
+ > REALM ID: 3
+ name: even
+ full path: /even
+ actions: []
+ templates: {}
+ parent id: 1
+ account policy id: null
+ password policy id: 4
+
+ > REALM ID: 4
+ name: two
+ full path: /even/two
+ actions: []
+ templates: {}
+ parent id: 3
+ account policy id: 5
+ password policy id: 2
+
+--
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/78204b93/src/main/asciidoc/cli.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli.adoc b/src/main/asciidoc/cli.adoc
index 582b140..4d6784d 100644
--- a/src/main/asciidoc/cli.adoc
+++ b/src/main/asciidoc/cli.adoc
@@ -50,4 +50,8 @@ include::cli-info.adoc[]
include::cli-entitlement.adoc[]
-include::cli-domain.adoc[]
\ No newline at end of file
+include::cli-domain.adoc[]
+
+include::cli-realm.adoc[]
+
+include::cli-group.adoc[]
\ No newline at end of file
[3/4] syncope git commit: cli docs: domain, SYNCOPE-722
Posted by ma...@apache.org.
cli docs: domain, SYNCOPE-722
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/748793c4
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/748793c4
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/748793c4
Branch: refs/heads/master
Commit: 748793c4386c301494efdc47fdfe9e821c45d06b
Parents: 80a04bb
Author: massi <ma...@tirasa.net>
Authored: Tue Dec 1 16:42:16 2015 +0100
Committer: massi <ma...@tirasa.net>
Committed: Tue Dec 1 16:42:16 2015 +0100
----------------------------------------------------------------------
src/main/asciidoc/cli.adoc | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/748793c4/src/main/asciidoc/cli.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli.adoc b/src/main/asciidoc/cli.adoc
index 1b0f4c4..582b140 100644
--- a/src/main/asciidoc/cli.adoc
+++ b/src/main/asciidoc/cli.adoc
@@ -48,4 +48,6 @@ include::cli-policy.adoc[]
include::cli-info.adoc[]
-include::cli-entitlement.adoc[]
\ No newline at end of file
+include::cli-entitlement.adoc[]
+
+include::cli-domain.adoc[]
\ No newline at end of file
[2/4] syncope git commit: cli docs: domain, SYNCOPE-722
Posted by ma...@apache.org.
cli docs: domain, SYNCOPE-722
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/80a04bb5
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/80a04bb5
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/80a04bb5
Branch: refs/heads/master
Commit: 80a04bb544d911ae6a252ac8c6a32a3ef3751b9e
Parents: 8875e0f
Author: massi <ma...@tirasa.net>
Authored: Tue Dec 1 16:42:08 2015 +0100
Committer: massi <ma...@tirasa.net>
Committed: Tue Dec 1 16:42:08 2015 +0100
----------------------------------------------------------------------
src/main/asciidoc/cli-domain.adoc | 95 ++++++++++++++++++++++++++++++++++
src/main/asciidoc/cli-policy.adoc | 2 -
2 files changed, 95 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/80a04bb5/src/main/asciidoc/cli-domain.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-domain.adoc b/src/main/asciidoc/cli-domain.adoc
new file mode 100644
index 0000000..3ff78d9
--- /dev/null
+++ b/src/main/asciidoc/cli-domain.adoc
@@ -0,0 +1,95 @@
+//
+// 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.
+//
+
+==== Domain command
+The domain command serves to retrieve the information about the configured domains.
+
+===== Help message
+[source,bash]
+----
+Usage: domain [options]
+ Options:
+ --help
+ --details
+ --list
+ --delete
+ Syntax: --delete {DOMAIN-NAME} {DOMAIN-NAME} [...]
+----
+
+===== Details option
+This option shows a table with domain amount.
+
+[source]
+--
+$ ./syncopeadm.sh domain --details
+--
+
+[source]
+--
+
+You are runnig: domain --details
+
+############################
+# #
+# DOMAINS DETAILS #
+# #
+############################
+# # #
+# DETAIL # VALUE #
+# # #
+############################
+# # #
+# Total number # 1 #
+# # #
+############################
+
+--
+
+===== List option
+Running the command with this option you will see the list of the domains.
+
+[source]
+--
+$ ./syncopeadm.sh domain --list
+--
+
+[source]
+--
+
+You are runnig: domain --list
+
+ > DOIMAIN NAME: Two
+ chiper algorithm: SHA
+
+--
+
+===== Delete option
+The option to delete a specified domain.
+
+[source]
+--
+$ ./syncopeadm.sh domain --delete {DOMAIN-NAME} {DOMAIN-NAME} [...]
+--
+
+The delete option, as can be imagined, tries to remove a specified domain.
+The output will be something like:
+[source]
+--
+ - Domain {DOMAIN-NAME} successfully deleted
+--
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/80a04bb5/src/main/asciidoc/cli-policy.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-policy.adoc b/src/main/asciidoc/cli-policy.adoc
index c3f0a5d..af51145 100644
--- a/src/main/asciidoc/cli-policy.adoc
+++ b/src/main/asciidoc/cli-policy.adoc
@@ -81,8 +81,6 @@ $ ./syncopeadm.sh Usage: policy --list {POLICY-TYPE}
[source]
--
-./syncopeadm.sh policy --list SYNC
-
You are runnig: policy --list SYNC
> KEY: 1