Skip to content

Commit

Permalink
Add a Java example
Browse files Browse the repository at this point in the history
  • Loading branch information
philippeVerney committed Jun 27, 2024
1 parent 06d3d4d commit 7a5b0f3
Show file tree
Hide file tree
Showing 6 changed files with 210 additions and 10 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ FETPAPI uses cmake as its build tool. A 3.12 version or later of cmake is requir
Remark : you can choose where FETPAPI will be installed (using "make install" on Linux or by generating the "INSTALL" project on Visual Studio) by setting the cmake variable called CMAKE_INSTALL_PREFIX
# How to start
As a first way to start, we advise people to look at examples provided with FESAPI. Please give a look at:
- C++ : client ([here](https://github.com/F2I-Consulting/fetpapiClient)) and server ([here](https://github.com/F2I-Consulting/fetpapiServer)) examples.
- C++ : [in example/withFesapi/etpClient.cpp](./example/withFesapi/etpClient.cpp) or [in example/withoutFesapi/etpClient.cpp](./example/withoutFesapi/etpClient.cpp)
- C# : client ([here](https://github.com/F2I-Consulting/fetpapiClient/tree/main/cs)) : FetpapiClient.cs will be generated by cmake configuration when WITH_DOTNET_WRAPPING is ON, the source file is initially located in ([cmake/Program.cs](https://github.com/F2I-Consulting/fetpapiClient/blob/main/cmake/FetpapiClient.cs.in))
- Java (JDK 1.5 and later) : client ([here](https://github.com/F2I-Consulting/fetpapiClient/tree/main/java))
- Java (JDK 1.5 and later) : in java/src/com/f2i_consulting/example/FetpapiClientUsingFesapi.java (FetpapiClientUsingFesapi.java will be generated by cmake configuration when WITH_JAVA_WRAPPING is ON, the source file is initially located [in cmake/FetpapiClientUsingFesapi.java](./cmake/FetpapiClientUsingFesapi.java))
- Python3 (no support for Python2) : in ([python/example/example.py](https://github.com/F2I-Consulting/fetpapiClient/tree/main/python/src/etp_client_example.py)) (please follow instructions in the documentation header of this example python file)

You can also find Doxygen generated documentation [here](https://f2i-consulting.com/fetpapi/doxygen/)
Expand Down
188 changes: 188 additions & 0 deletions cmake/FetpapiClientUsingFesapi.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
/*-----------------------------------------------------------------------
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.
-----------------------------------------------------------------------*/
package com.f2i_consulting.fetpapi.client;

import java.util.Optional;
import java.util.UUID;
import java.util.concurrent.TimeUnit;

import com.f2i_consulting.fesapi.SWIGTYPE_p_double;
import com.f2i_consulting.fesapi.fesapi;
import com.f2i_consulting.fesapi.common.DataObjectRepository;
import com.f2i_consulting.fesapi.resqml2.AbstractValuesProperty;
import com.f2i_consulting.fesapi.resqml2.IjkGridExplicitRepresentation;
import com.f2i_consulting.fetpapi.DataspaceVector;
import com.f2i_consulting.fetpapi.MapStringDataObject;
import com.f2i_consulting.fetpapi.MapStringString;
import com.f2i_consulting.fetpapi.ResourceVector;
import com.f2i_consulting.fetpapi.fetpapi;
import com.f2i_consulting.fetpapi.Energistics.Etp.v12.Datatypes.Object.ContextInfo;
import com.f2i_consulting.fetpapi.Energistics.Etp.v12.Datatypes.Object.ContextScopeKind;
import com.f2i_consulting.fetpapi.Energistics.Etp.v12.Datatypes.Object.DataObject;
import com.f2i_consulting.fetpapi.Energistics.Etp.v12.Datatypes.Object.Dataspace;
import com.f2i_consulting.fetpapi.Energistics.Etp.v12.Datatypes.Object.Resource;
import com.f2i_consulting.fetpapi.etp.ClientSession;
import com.f2i_consulting.fetpapi.etp.CoreHandlers;
import com.f2i_consulting.fetpapi.etp.DataArrayHandlers;
import com.f2i_consulting.fetpapi.etp.DataspaceHandlers;
import com.f2i_consulting.fetpapi.etp.DiscoveryHandlers;
import com.f2i_consulting.fetpapi.etp.FesapiHdfProxyFactory;
import com.f2i_consulting.fetpapi.etp.InitializationParameters;
import com.f2i_consulting.fetpapi.etp.StoreHandlers;

public class FetpapiClientUsingFesapi {

/**
* Loading the FesapiCpp and Fetpapi native libraries
*/
static {
try {
System.loadLibrary("${FESAPI_ASSEMBLY_NAME}");
}
catch (UnsatisfiedLinkError e) {
System.out.println("UnsatisfiedLinkError : " + e.toString());
}
try {
System.loadLibrary("${ASSEMBLY_NAME}");
}
catch (UnsatisfiedLinkError e) {
System.out.println("UnsatisfiedLinkError : " + e.toString());
}
}

public static void main(String[] args) {
// Read arguments of the command line
String serverUrl = "ws://etp.f2i-consulting.com:9002/";
String authorization = "";

if (args.length < 1) {
System.out.println("Program arguments should be : serverUrl \"<BearerOrBasic> <token>\"");
System.out.println("WARNING : you did not provide a server URL. The URL will be defaulted to ws://etp.f2i-consulting.com:9002/");
}
else {
serverUrl = args[0];
if (args.length < 2) {
System.out.println("Program arguments should be : serverUrl \"Bearer <token>\"");
System.out.println("WARNING : You did not provide any authorizaton after the URL. Please see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization for further details");
}
else {
if (!args[1].startsWith("Basic ") && !args[1].startsWith("Bearer ")) {
System.out.println("WARNING : HTTP authorization \"" + args[3] + "\" field does not start with \"Basic \" nor \"Bearer \" which is unlikely");
}
authorization = args[1];
}
}

// Create a DataObjectRepository in order to store retrieved dataobjects from the ETP server
try (DataObjectRepository repo = new DataObjectRepository()) {
repo.setDefaultStandard(DataObjectRepository.EnergisticsStandard.RESQML2_0_1);
repo.setDefaultStandard(DataObjectRepository.EnergisticsStandard.EML2_0);

// ****** Connect to ETP server through clientSession ******
String instanceUuid = UUID.randomUUID().toString();
InitializationParameters initializationParams = new InitializationParameters(instanceUuid, serverUrl);
MapStringString additionalHeaderField = new MapStringString();
additionalHeaderField.put("data-partition-id", "osdu"); // Example for OSDU RDDMS
initializationParams.setAdditionalHandshakeHeaderFields(additionalHeaderField);

ClientSession clientSession = fetpapi.createClientSession(initializationParams, authorization);
clientSession.setCoreProtocolHandlers(new CoreHandlers(clientSession));
clientSession.setDataspaceProtocolHandlers(new DataspaceHandlers(clientSession));
clientSession.setDiscoveryProtocolHandlers(new DiscoveryHandlers(clientSession));
clientSession.setStoreProtocolHandlers(new StoreHandlers(clientSession));
clientSession.setDataArrayProtocolHandlers(new DataArrayHandlers(clientSession));
new Thread(clientSession::run).start();
long start = System.currentTimeMillis();
while (clientSession.isEtpSessionClosed() && System.currentTimeMillis() - start < 5000) {
TimeUnit.MILLISECONDS.sleep(1);
}
if (clientSession.isEtpSessionClosed()) {
System.err.println("The ETP session cound not be establisehd in 5 seconds.");
return;
}
System.out.println("Now connected to ETP Server");
// ****** We are now connected to ETP server through clientSession ******
// Set the HDF proxy factory in order to use one compliant with ETP
repo.setHdfProxyFactory(new FesapiHdfProxyFactory(clientSession));

// ****** Get a dataspace content. This corresponds to getting the content of an EPC file ******
// Find an available ETP dataspace
DataspaceVector allDataspaces = clientSession.getDataspaces();
Optional<Dataspace> dataspace = allDataspaces.stream().findAny();
if (dataspace.isEmpty()) {
clientSession.close();
System.err.println("The ETP server has no dataspace.");
return;
}
System.out.println("Working on dataspace " + dataspace.get().getUri());
// List resources of this ETP dataspace
ContextInfo etpContext = new ContextInfo();
etpContext.setUri(dataspace.get().getUri());
etpContext.setDepth(1);
ResourceVector allResources = clientSession.getResources(etpContext, ContextScopeKind.self);
if (allResources.isEmpty()) {
clientSession.close();
System.err.println("The ETP dataspace has no resource.");
return;
}
// Get dataobjects from the resources to the DataObjectRepository
MapStringString uriMap = new MapStringString();
long index = 0;
for (Resource resource : allResources) {
uriMap.put(Long.toString(index++), resource.getUri());
}
MapStringDataObject allDataObjects = clientSession.getDataObjects(uriMap);
for (DataObject dataObject : allDataObjects.values()) {
repo.addOrReplaceGsoapProxy(dataObject.getData(), fetpapi.getDataObjectType(dataObject.getResource().getUri()), fetpapi.getDataspaceUri(dataObject.getResource().getUri()));
}
// ****** We have now in the DataObjectRepository the same content as if we would have deserialized and EPC file looking like the dataspace ******

// ****** Use the DataObjectRepository exactly as you are used to do with FESAPI ******
if (repo.getIjkGridRepresentationCount() > 0) {
IjkGridExplicitRepresentation ijkGrid = repo.getIjkGridExplicitRepresentation(0);
ijkGrid.loadSplitInformation();
long originIndex = ijkGrid.getXyzPointIndexFromCellCorner(0, 0, 0, 0);
System.out.println("The index of the grid origin in XYZ points is : " + originIndex);
ijkGrid.unloadSplitInformation();
if (ijkGrid.getValuesPropertyCount() > 0) {
AbstractValuesProperty prop = ijkGrid.getValuesProperty(0);
SWIGTYPE_p_double propValues = fesapi.new_DoubleArray(prop.getValuesCountOfPatch(0));
try {
prop.getDoubleValuesOfPatch(0, propValues);
System.out.println("The first cell value of prop " + prop.getTitle() + " is " + fesapi.DoubleArray_getitem(propValues, 0));
}
finally {
fesapi.delete_DoubleArray(propValues);
}
}
}
else {
System.out.println("This dataspace has no IJK Grid");
}

// Do not forget to close session once you have processed all the dataobject repository.
System.out.println("Closing the session...");
clientSession.close();
} catch (InterruptedException e) {
e.printStackTrace();
}

System.out.println("FINISHED");
}
}
18 changes: 13 additions & 5 deletions java/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Included in ../src/CMakeLists.txt if java build is selected.
# Included in ../CMakeLists.txt if java build is selected.

find_package(SWIG 3.0 REQUIRED)
find_package(SWIG 3.4 REQUIRED)

find_package(JNI REQUIRED)
find_package(Java REQUIRED)
include(UseJava)

set(SWIG_LINKED_TO_RELEASE ON CACHE BOOL "Is your SWIG generated library linked to the release or debug version of FesapiCpp ?")
set(SWIG_LINKED_TO_RELEASE ON CACHE BOOL "Is your SWIG generated library linked to the release or debug version of Fetpapi ?")

message("Generating SWIG Java files...")
#Cleaning
Expand All @@ -17,7 +17,7 @@ endif (TO_DELETE)
file (REMOVE_RECURSE ${CMAKE_SOURCE_DIR}/java/src/com/f2i_consulting/fetpapi/etp)

# The name of the library is different on Windows because it includes the version
# The assembly name is used to load the debug vs release FESAPI library in the Java example
# The assembly name is used to load the debug vs release FETPAPI library in the Java example
if (WIN32)
if (SWIG_LINKED_TO_RELEASE)
set (ASSEMBLY_NAME ${PROJECT_NAME}${CMAKE_RELEASE_POSTFIX}.${Fetpapi_VERSION})
Expand All @@ -31,6 +31,14 @@ else (WIN32)
set (ASSEMBLY_NAME ${PROJECT_NAME}${CMAKE_DEBUG_POSTFIX})
endif (SWIG_LINKED_TO_RELEASE)
endif (WIN32)
if (WITH_FESAPI)
if (SWIG_LINKED_TO_RELEASE)
get_filename_component(FESAPI_ASSEMBLY_NAME ${FESAPI_LIBRARY_RELEASE} NAME_WLE)
else (SWIG_LINKED_TO_RELEASE)
get_filename_component(FESAPI_ASSEMBLY_NAME ${FESAPI_LIBRARY_DEBUG} NAME_WLE)
endif (SWIG_LINKED_TO_RELEASE)
configure_file(${CMAKE_SOURCE_DIR}/cmake/FetpapiClientUsingFesapi.java ${CMAKE_SOURCE_DIR}/java/src/com/f2i_consulting/example/FetpapiClientUsingFesapi.java) # Overwrite if different(WIN32)
endif (WITH_FESAPI)

# SWIG execution
set (EXECUTE_COMMAND "${SWIG_EXECUTABLE}")
Expand Down Expand Up @@ -95,7 +103,7 @@ if (SWIG_LINKED_TO_RELEASE)
)
else (SWIG_LINKED_TO_RELEASE)
install (
FILES ${CMAKE_CURRENT_BINARY_DIR}/fetpapiJava${CMAKE_DEBUG_POSTFIX}-${Fesapi_VERSION}.jar
FILES ${CMAKE_CURRENT_BINARY_DIR}/fetpapiJava${CMAKE_DEBUG_POSTFIX}-${Fetpapi_VERSION}.jar
DESTINATION ${CMAKE_INSTALL_LIBDIR}
)
endif (SWIG_LINKED_TO_RELEASE)
4 changes: 4 additions & 0 deletions java/src/com/f2i_consulting/example/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Ignore everything in this directory
*
# Except this file
!.gitignore
2 changes: 1 addition & 1 deletion src/etp/fesapi/FesapiHdfProxy.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Energistics::Etp::v12::Datatypes::DataArrayTypes::DataArrayMetadata FesapiHdfPro
return handlers->getDataArrayMetadata();
}

COMMON_NS::AbstractObject::numericalDatatypeEnum FesapiHdfProxy::getNumericalDatatype(const std::string & datasetName)
COMMON_NS::AbstractObject::numericalDatatypeEnum FesapiHdfProxy::getNumericalDatatype(const std::string & datasetName)
{
const auto daMetadata = getDataArrayMetadata(datasetName);
switch (daMetadata.transportArrayType) {
Expand Down
4 changes: 2 additions & 2 deletions src/etp/fesapi/FesapiHdfProxy.h
Original file line number Diff line number Diff line change
Expand Up @@ -487,9 +487,9 @@ namespace ETP_NS
// First get metadata about the data array
std::vector<uint64_t> dimensions;

const auto daMetadata = getDataArrayMetadata(datasetName);
const Energistics::Etp::v12::Datatypes::DataArrayTypes::DataArrayMetadata daMetadata = getDataArrayMetadata(datasetName);
size_t valueCount = 1;
for (auto dim : daMetadata.dimensions) {
for (int64_t dim : daMetadata.dimensions) {
valueCount *= dim;
}

Expand Down

0 comments on commit 7a5b0f3

Please sign in to comment.