The following document describes how to create the Producer application in the demo. This application generates a pushes the content into the queue. It is designed to be run anywhere (local desktop or VM, for example).
The folder includes two scripts (provided in Windows (.bat) and Linux bash (.sh) formats. As a recommended precaution, it is worth running the dos2unix and unix2dos scripts on these files just in case a version is pushed that hasn't been corrected.
- getStats.[bat|sh] - this script sets the environment variable to tell the application that the configuration file with the properties necessary is in the same directory as where you run the tool from. It then uses Maven to create and execute the tool, which will then send to the console details of the test queue.
- producer.[bat|sh] - this script works in the same way as the getStats script by setting the environment variable and then using Maven to compile and execute the utility. The difference being this will then start generating and putting messages in the Queue.
As the Java utility needs to communicate with OCI, it requires the user details to authenticate the user, as mentioned in the overall readme and explained in the SDK documentation. You may wish to use separate users for the producer and consumer.
- Java JDK 8 or later
- Oracle OCI SDK
- Maven
- User with the privileges to interact with the OCI Queue - we describe a simple solution to this in the parent readme.
Maven and Java are assumed to be visible using the PATH environment variable.
Within the code is a class called Environment (src/main/java/com/demo/samples/basic/Environment.java) which declares several constants that capture the OCI Queue OCID, the URL for the OCI Data Plane endpoint, and the attributes necessary for authenticating and authorization to use the service.
These values need to have their defaults replaced with the appropriate values established during the OCI Queue setup.
If the Queue is not configured in the Phoenix region, then the region part of the name(for the data plane URL) needs to be modified to reflect the region being used.
Once you update Enviornment.java , then you have to build your project. This is a maven-based project we can use standard maven commands like this:
*mvn clean package*
Once the command is executed successfully, it will create a jar file in ./target folder.
Post successful execution of the above command, you can run .bat/.sh file to see producer/getStat in action.
We are going to use instance principal (assuming we are running it on OCI instance), so we have to create a dynamic group, e.g., dynamic group name should be queue_dg . We can use the following commands (remember to replace the with your own actual values):
ALL {instance.compartment.id='<instance Compartment id>'}
please use the following policy
allow dynamic-group queue_dg to use queues in compartment <queue_parent_compartment>
The above policies and dynamic group are needed when using instance principal(when you are hosting and running it from OCI virtual machine), if you are planning to run it locally(on a laptop/desktop), then you will have to generate API keys and ensure you have access to queue service using a grou ,e.g.
Allow group \<user group name\> to use queues in compartment \<compartment name of queue parent compartment\>
None
- These will be unique to the deployment
This project is open source. Please submit your contributions by forking this repository and submitting a pull request! Oracle appreciates any contributions that are made by the open-source community.
Copyright (c) 2024 Oracle and/or its affiliates.
Licensed under the Universal Permissive License (UPL), Version 1.0.
See LICENSE for more details.
ORACLE AND ITS AFFILIATES DO NOT PROVIDE ANY WARRANTY WHATSOEVER, EXPRESS OR IMPLIED, FOR ANY SOFTWARE, MATERIAL OR CONTENT OF ANY KIND CONTAINED OR PRODUCED WITHIN THIS REPOSITORY, AND IN PARTICULAR SPECIFICALLY DISCLAIM ANY AND ALL IMPLIED WARRANTIES OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. FURTHERMORE, ORACLE AND ITS AFFILIATES DO NOT REPRESENT THAT ANY CUSTOMARY SECURITY REVIEW HAS BEEN PERFORMED WITH RESPECT TO ANY SOFTWARE, MATERIAL OR CONTENT CONTAINED OR PRODUCED WITHIN THIS REPOSITORY. IN ADDITION, AND WITHOUT LIMITING THE FOREGOING, THIRD PARTIES MAY HAVE POSTED SOFTWARE, MATERIAL OR CONTENT TO THIS REPOSITORY WITHOUT ANY REVIEW. USE AT YOUR OWN RISK.