Bug 1317478 - Incorrect and insufficient instructions for using CLI in Embedded Mode
Summary: Incorrect and insufficient instructions for using CLI in Embedded Mode
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: JBoss Data Grid 6
Classification: JBoss
Component: Documentation
Version: 6.6.0
Hardware: All
OS: All
unspecified
low
Target Milestone: ---
: ---
Assignee: Christian Huffman
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-03-14 10:52 UTC by Vijay B. Chintalapati
Modified: 2019-01-30 19:49 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Build Name: 23149, Administration and Configuration Guide-6.6 Build Date: 10-03-2016 17:24:32 Topic ID: 13820-682710 [Specified]
Last Closed: 2019-01-30 19:49:53 UTC
Type: Bug


Attachments (Terms of Use)

Description Vijay B. Chintalapati 2016-03-14 10:52:11 UTC
Title: Start the Library Mode CLI (Server)

Describe the issue:

The instructions for starting CLI server in embedded mode are incorrect. The given instructions are for Client/Server mode. 

Suggestions for improvement:

More details need to be provided to as to what should be included in the embedded-mode project to be able to successfully start the CLI server.

Additional information:

1. The embedded mode project needs to include the infinispan-cli-server-${jdg-version}  and transaction-api-1.1jar (or equivalent to provide transaction API support) in its classpath

In a Maven project this would translate to:

	<dependency>
		<groupId>org.infinispan</groupId>
		<artifactId>infinispan-cli-server</artifactId>
		<version>${infinispan.version}</version>
	</dependency>
	<dependency>
		<groupId>javax.transaction</groupId>
		<artifactId>transaction-api</artifactId>
		<version>1.1</version>
	</dependency>

2. The cli.(sh|bat) scripts location (jboss-datagrid-6.6.x-library/bin) should be emphasized for clarity. 

3. The cache manager (within the application) should in a running state. This is covered in Table 23.1 with "-c" option.

4. To be able to do a "put" of the following form, the class package.MyClass should be available to the classloader. Needs to be confirmed but this works best only with Embedded mode. Also, this automatically means there are public setter methods for "i", "x", "b" in the form of setI(...), setX(...) and setB(...) respectively. Lack of a public setter method would cause the command to fail.
 
put e { "package.MyClass": {"i": 5, "x": null, "b": true } }

5. To be able to do a "get" and get a JSON representation, the class type of the value instance should include one or more public getter methods. The public method String getItem would be translated to "item":"Ball" (for example) in JSON representation whether or not there is a "item" member for the given class type

6. Decouple or eliminate the confusing Client/Server CLI instructions in 23.1.1, Table 23.1 "-c" option, last sentence in the Note of 23.1.4

Comment 2 Christian Huffman 2019-01-30 19:49:53 UTC
I'm closing this issue out due to age. If it persists, file a corresponding JIRA.


Note You need to log in before you can comment on or make changes to this bug.