Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/* ----------------------------------------------------------------------------
* Copyright (C) 2021 European Space Agency
* European Space Operations Centre
* Darmstadt
* Germany
* ----------------------------------------------------------------------------
* System : CCSDS MO MAL Java API
* ----------------------------------------------------------------------------
* Licensed under the European Space Agency Public License, Version 2.0
* You may not use this file except in compliance with the License.
*
* Except as expressly set forth in this License, the Software is provided to
* You on an "as is" basis and without warranties of any kind, including without
* limitation merchantability, fitness for a particular purpose, absence of
* defects or errors, accuracy or non-infringement of intellectual property rights.
*
* See the License for the specific language governing permissions and
* limitations under the License.
* ----------------------------------------------------------------------------
*/
package org.ccsds.moims.mo.mal.helpertools.helpers;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.util.Properties;
import java.util.Set;
import java.util.TreeSet;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.ccsds.moims.mo.mal.MALArea;
import org.ccsds.moims.mo.mal.MALContextFactory;
import org.ccsds.moims.mo.mal.MALException;
import org.ccsds.moims.mo.mal.MALService;
import org.ccsds.moims.mo.mal.structures.Attribute;
import org.ccsds.moims.mo.mal.structures.Identifier;
import org.ccsds.moims.mo.mal.structures.IdentifierList;
import org.ccsds.moims.mo.mal.structures.UOctet;
import org.ccsds.moims.mo.mal.structures.UShort;
/**
* A Helper with miscellaneous methods and static variables.
*/
public class HelperMisc {
private static final Set LOADED_PROPERTIES = new TreeSet();
public static final String TRANSPORT_PROPERTIES_FILE = "transport.properties";
public static final String PROVIDER_PROPERTIES_FILE = "provider.properties";
public static final String CONSUMER_PROPERTIES_FILE = "consumer.properties";
public static final String SHARED_BROKER_PROPERTIES = "sharedBroker.properties";
public static final String SHARED_BROKER_URI = "sharedBrokerURI.properties";
public static final String PROVIDER_URIS_PROPERTIES_FILENAME = "providerURIs.properties";
public static final String PROVIDER_URIS_SECONDARY_PROPERTIES_FILENAME = "providerURIsSecondary.properties";
public static final String PROPERTY_SHARED_BROKER_URI = "esa.mo.helpertools.connections.SharedBrokerURI";
// These are used by the Apps Launcher service
public final static String APP_VERSION = "helpertools.configurations.provider.app.version";
public final static String APP_CATEGORY = "helpertools.configurations.provider.app.category";
public final static String APP_COPYRIGHT = "helpertools.configurations.provider.app.copyright";
public final static String APP_DESCRIPTION = "helpertools.configurations.provider.app.description";
public final static String APP_USER = "helpertools.configurations.provider.app.user";
public static final String PROP_MO_APP_NAME = "helpertools.configurations.MOappName";
public static final String PROP_DOMAIN = "helpertools.configurations.provider.Domain";
public static final String PROP_NETWORK = "helpertools.configurations.Network";
// Fine-tunning Network properties (only works if the NETWORK is not set)
public static final String PROP_ORGANIZATION_NAME = "helpertools.configurations.OrganizationName";
public static final String PROP_MISSION_NAME = "helpertools.configurations.MissionName";
public static final String PROP_NETWORK_ZONE = "helpertools.configurations.NetworkZone";
public static final String PROP_DEVICE_NAME = "helpertools.configurations.DeviceName";
public static final String PROP_GPS_POLL_RATE_MS = "helpertools.configurations.gpspollrate";
public static final String PROP_GPS_POLLING_ACTIVE = "helpertools.configurations.pollgps";
private static final String PROP_TRANSPORT_ID = "helpertools.configurations.provider.transportfilepath";
private static final String SETTINGS_PROPERTY = "esa.mo.nanosatmoframework.provider.settings";
public static final String SECONDARY_PROTOCOL = "org.ccsds.moims.mo.mal.transport.secondary.protocol";
public static final String PROPERTY_APID_QUALIFIER = "org.ccsds.moims.mo.malspp.apidQualifier";
public static final String PROPERTY_APID = "org.ccsds.moims.mo.malspp.apid";
public static final Identifier SESSION_NAME = new Identifier("LIVE");
/**
* Clears the list of loaded property files.
*/
public static void clearLoadedPropertiesList() {
LOADED_PROPERTIES.clear();
}
/**
* Loads in a property file and optionally searches for a contained property
* that contains the next file to load.
*
* @param configFile The name of the property file to load. May be null, in
* which case nothing is loaded.
* @param chainProperty The property name that contains the name of the next
* file to load.
* @return The loaded properties or an empty list if no file loaded.
*/
private static Properties loadProperties(final String configFile, final String chainProperty) {
Properties topProps = new Properties();
if (null != configFile) {
topProps = loadProperties(ClassLoader.getSystemClassLoader().getResource(configFile),
chainProperty);
}
return topProps;
}
/**
* Loads the properties for the consumer
*
* @throws java.net.MalformedURLException if the URI could not be converted
* into a URL.
* @throws IOException if the file consumer properties file does no exist
*/
public static void loadConsumerProperties() throws MalformedURLException, IOException {
final Properties sysProps = System.getProperties();
final File file = new File(System.getProperty("consumer.properties", CONSUMER_PROPERTIES_FILE));
if (file.exists()) {
sysProps.putAll(HelperMisc.loadProperties(file.toURI().toURL(), "consumer.properties"));
} else {
throw new IOException("The file " + file.getName() + " does not exist.");
}
System.setProperties(sysProps);
}
/**
* Loads in a property file and optionally searches for a contained property
* that contains the next file to load.
*
* @param url The URL of the property file to load. May be null, in which
* case nothing is loaded.
* @param chainProperty The property name that contains the name of the next
* file to load.
* @return The loaded properties or an empty list if no file loaded.
* @throws java.lang.IllegalArgumentException If chainProperty == null.
*/
public static Properties loadProperties(final java.net.URL url, final String chainProperty)
throws IllegalArgumentException {
final Properties topProps = new Properties();
if (chainProperty == null) {
throw new IllegalArgumentException("ChainProperty must not be null. Please "
+ "provide an empty String if you do not want to provide a chainProperty.");
}
if (null != url) {
try {
final Properties myProps = new Properties();
InputStream stream = url.openStream();
myProps.load(stream);
stream.close();
final Properties subProps = loadProperties(myProps.getProperty(chainProperty),
chainProperty);
String loadingString = (LOADED_PROPERTIES.contains(url.toString()))
? "Reloading properties " + url.toString()
: "Loading properties " + url.toString();
Logger.getLogger(HelperMisc.class.getName()).log(Level.INFO, loadingString);
topProps.putAll(subProps);
topProps.putAll(myProps);
LOADED_PROPERTIES.add(url.toString());
} catch (IOException ex) {
Logger.getLogger(HelperMisc.class.getName()).log(Level.WARNING,
"Failed to load properties " + url, ex);
}
}
return topProps;
}
/**
* Loads in a property file.
*
* @param path The path of the property file to load.
* @return The loaded properties or an empty list if no file loaded.
* @throws IOException The file could not be loaded.
* @throws IllegalArgumentException If path == null
*/
public static Properties loadProperties(final String path)
throws IOException, IllegalArgumentException {
if (path == null) {
throw new IllegalArgumentException("Filepath must not be null.");
}
final File file = new File(path);
final FileInputStream inputStream = new FileInputStream(file);
final Properties ret = new Properties();
ret.load(inputStream);
inputStream.close();
return ret;
}
/**
* Loads the provider properties file
*/
public static void loadPropertiesFile() {
HelperMisc.loadPropertiesFile(false);
}
/**
* Loads the provider properties file and the properties for the shared
* broker
*
* @param useSharedBroker Flag that determines if the properties in the
* SHARED_BROKER_PROPERTIES file will be read
*/
public static void loadPropertiesFile(Boolean useSharedBroker) {
// Were they loaded already?
String propAreLoaded = System.getProperty("PropertiesLoadedFlag");
if (propAreLoaded != null) {
if (System.getProperty("PropertiesLoadedFlag").equals("true")) {
return;
}
}
try {
final java.util.Properties sysProps = System.getProperties();
File file;
final String providerFile = System.getProperty("provider.properties",
PROVIDER_PROPERTIES_FILE);
if (providerFile != null) {
file = new File(providerFile);
if (file.exists()) {
sysProps.putAll(HelperMisc.loadProperties(file.toURI().toURL(), "provider.properties"));
} else {
Logger.getLogger(HelperMisc.class.getName()).log(Level.WARNING,
"The file provider.properties does not exist on the "
+ "path: {}. Is the application working directory "
+ "configured properly?", providerFile);
}
}
final String settingsFile = System.getProperty(SETTINGS_PROPERTY, "settings.properties");
if (settingsFile != null) {
file = new File(settingsFile);
if (file.exists()) {
sysProps.putAll(HelperMisc.loadProperties(file.toURI().toURL(), "settings.properties"));
} else {
Logger.getLogger(HelperMisc.class.getName()).log(Level.WARNING,
"The file settings.properties does not exist on the "
+ "path: {}. Is the application working directory "
+ "configured properly?", settingsFile);
}
}
String transport_file_path = TRANSPORT_PROPERTIES_FILE;
String trans_path_prop = System.getProperty(PROP_TRANSPORT_ID);
if (trans_path_prop != null) {
transport_file_path = trans_path_prop;
}
file = new File(System.getProperty("transport.properties", transport_file_path));
if (file.exists()) {
sysProps.putAll(HelperMisc.loadProperties(file.toURI().toURL(), "transport.properties"));
} else {
Logger.getLogger(HelperMisc.class.getName()).log(Level.WARNING,
"The file transport.properties does not exist on the "
+ "path: {}. Is the application working directory "
+ "configured properly?", transport_file_path);
}
if (useSharedBroker) {
file = new File(System.getProperty("sharedBroker.properties", SHARED_BROKER_PROPERTIES));
if (file.exists()) {
sysProps
.putAll(HelperMisc.loadProperties(file.toURI().toURL(), "sharedBroker.properties"));
}
file = new File(System.getProperty("sharedBrokerURI.properties", SHARED_BROKER_URI));
if (file.exists()) {
sysProps.putAll(
HelperMisc.loadProperties(file.toURI().toURL(), "sharedBrokerURI.properties"));
}
}
System.setProperties(sysProps);
System.setProperty("PropertiesLoadedFlag", "true");
} catch (MalformedURLException ex) {
Logger.getLogger(HelperMisc.class.getName()).log(Level.SEVERE, null, ex);
}
}
/**
* Loads in the properties of a file.
*
* @param propertiesFileName The name of the property file to load.
* @throws java.lang.IllegalArgumentException If propertiesFileName == null
*/
public static void loadThisPropertiesFile(final String propertiesFileName)
throws IllegalArgumentException {
if (propertiesFileName == null) {
throw new IllegalArgumentException("propertiesFileName must not be null.");
}
final java.util.Properties sysProps = System.getProperties();
File file = new File(propertiesFileName);
if (file.exists()) {
try {
sysProps.putAll(HelperMisc.loadProperties(file.toURI().toURL(), PROVIDER_PROPERTIES_FILE));
} catch (MalformedURLException ex) {
Logger.getLogger(HelperMisc.class.getName()).log(Level.SEVERE, null, ex);
}
}
System.setProperties(sysProps);
}
/**
* Checks if an attribute is an Identifier, String or URI MAL data type.
*
* @param obj The attribute
* @return True if the object can be read as a string
* @throws java.lang.IllegalArgumentException If obj == null
*/
public static boolean isStringAttribute(Attribute obj) throws IllegalArgumentException {
if (obj == null) {
throw new IllegalArgumentException("Obj must not be null");
}
Integer shortFormPart = obj.getTypeShortForm();
if (shortFormPart == 6) { // Identifier
return true;
}
if (shortFormPart == 15) { // String
return true;
}
if (shortFormPart == 18) { // URI
return true;
}
return false;
}
/**
* Generates the domain field in an IdentifierList from a String separated
* by dots
*
* @param domainId The domain Id
* @return The domain as IdentifierList or an empty IdentifierList if
* domainId == null OR domainId.isEmpty
*/
public static IdentifierList domainId2domain(String domainId) {
if (domainId == null || domainId.isEmpty()) {
return new IdentifierList();
}
IdentifierList output = new IdentifierList();
String[] parts = domainId.split("\\.");
for (String part : parts) {
output.add(new Identifier(part));
}
return output;
}
/**
* Generates the domain string from an IdentifierList
*
* @param domain The domain
* @return The domain Id
*/
public static String domain2domainId(final IdentifierList domain) {
if (domain == null) {
return null;
}
if (domain.isEmpty()) {
return "";
}
String domainId = "";
for (Identifier subdomain : domain) {
domainId += subdomain.getValue() + ".";
}
// Remove the last dot and return the string
return domainId.substring(0, domainId.length() - 1);
}
/**
* Finds the service name from the area, areaVersion and service numbers
*
* @param area Area of the service
* @param areaVersion Area version of the service
* @param service Service number
* @return The name of the service
* @throws org.ccsds.moims.mo.mal.MALException The area/service is Unknown
*/
@Deprecated
public static String serviceKey2name(UShort area, UOctet areaVersion, UShort service)
throws MALException {
MALArea malArea = MALContextFactory.lookupArea(area, areaVersion);
if (malArea == null) {
throw new MALException(
"(" + area.getValue() + "," + areaVersion.getValue() + "," + service.getValue() + ") "
+ "Unknown area to the MAL! Maybe the API was not initialized.");
}
MALService malSer = malArea.getServiceByNumber(service);
if (malSer == null) {
throw new MALException(
"(" + area.getValue() + "," + areaVersion.getValue() + "," + service.getValue() + ") "
+ "Unknown service to the MAL! Maybe the API was not initialized.");
}
return malSer.getName().toString();
}
public static void setInputProcessorsProperty() {
System.setProperty("org.ccsds.moims.mo.mal.transport.gen.inputprocessors", "5");
}
}
