All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.opencrx.kernel.utils.Utils Maven / Gradle / Ivy

Go to download

openCore/Client Library

The newest version!
/*
 * ====================================================================
 * Project:     openCRX/Core, http://www.opencrx.org/
 * Description: Utils
 * Owner:       the original authors.
 * ====================================================================
 *
 * This software is published under the BSD license
 * as listed below.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions 
 * are met:
 * 
 * * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in
 * the documentation and/or other materials provided with the
 * distribution.
 * 
 * * Neither the name of the openCRX team nor the names of the contributors
 * to openCRX may be used to endorse or promote products derived
 * from this software without specific prior written permission
 * 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * ------------------
 * 
 * This product includes software developed by the Apache Software
 * Foundation (http://www.apache.org/).
 * 
 * This product includes software developed by contributors to
 * openMDX (http://www.openmdx.org/)
 */
package org.opencrx.kernel.utils;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.math.BigDecimal;
import java.math.MathContext;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.security.SecureRandom;
import java.text.DateFormat;
import java.text.DecimalFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Properties;
import java.util.Random;
import java.util.Set;
import java.util.TimeZone;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import javax.jdo.Constants;
import javax.jdo.FetchGroup;
import javax.jdo.JDOHelper;
import javax.jdo.PersistenceManager;
import javax.jdo.PersistenceManagerFactory;
import javax.jmi.reflect.RefObject;
import javax.naming.NamingException;
import javax.resource.cci.MappedRecord;

import org.oasisopen.jmi1.RefContainer;
import org.opencrx.kernel.account1.jmi1.Account1Package;
import org.opencrx.kernel.activity1.jmi1.Activity1Package;
import org.opencrx.kernel.admin1.jmi1.Admin1Package;
import org.opencrx.kernel.building1.jmi1.Building1Package;
import org.opencrx.kernel.contract1.jmi1.Contract1Package;
import org.opencrx.kernel.depot1.jmi1.Depot1Package;
import org.opencrx.kernel.forecast1.jmi1.Forecast1Package;
import org.opencrx.kernel.generic.SecurityKeys;
import org.opencrx.kernel.generic.jmi1.GenericPackage;
import org.opencrx.kernel.home1.jmi1.Home1Package;
import org.opencrx.kernel.home1.jmi1.UserHome;
import org.opencrx.kernel.product1.jmi1.Product1Package;
import org.opencrx.kernel.uom1.jmi1.Uom1Package;
import org.opencrx.security.realm1.jmi1.Realm1Package;
import org.openmdx.application.rest.ejb.DataManager_2ProxyFactory;
import org.openmdx.application.rest.http.SimplePort;
import org.openmdx.base.accessor.jmi.cci.RefObject_1_0;
import org.openmdx.base.accessor.jmi.spi.EntityManagerFactory_1;
import org.openmdx.base.accessor.rest.DirtyObjects;
import org.openmdx.base.dataprovider.layer.persistence.jdbc.Database_2;
import org.openmdx.base.dataprovider.layer.persistence.jdbc.spi.Database_2_0;
import org.openmdx.base.exception.ServiceException;
import org.openmdx.base.jmi1.Authority;
import org.openmdx.base.mof.cci.AggregationKind;
import org.openmdx.base.mof.cci.ModelElement_1_0;
import org.openmdx.base.mof.cci.Model_1_0;
import org.openmdx.base.mof.spi.Model_1Factory;
import org.openmdx.base.naming.Path;
import org.openmdx.base.persistence.cci.ConfigurableProperty;
import org.openmdx.base.persistence.cci.Queries;
import org.openmdx.base.persistence.cci.UserObjects;
import org.openmdx.base.rest.spi.Object_2Facade;
import org.openmdx.base.rest.spi.Query_2Facade;
import org.openmdx.base.rest.spi.RestConnectionFactory;
import org.openmdx.base.text.conversion.UUIDConversion;
import org.openmdx.base.transaction.TransactionAttributeType;
import org.openmdx.kernel.configuration.Configurations;
import org.openmdx.kernel.configuration.PropertiesProvider;
import org.openmdx.kernel.configuration.cci.Configuration;
import org.openmdx.kernel.id.UUIDs;
import org.openmdx.kernel.loading.Factory;
import org.openmdx.kernel.loading.PlugInFactory;
import org.openmdx.kernel.loading.Resources;
import org.openmdx.portal.servlet.UserSettings;
import org.openmdx.portal.servlet.attribute.DateValue;
import org.openmdx.security.realm1.jmi1.Permission;
import org.openmdx.security.realm1.jmi1.Role;

public abstract class Utils {

    /**
     * Get handle to model repository.
     * 
     * @return
     */
    public static Model_1_0 getModel(
    ) {
        Model_1_0 model = null;
        try {
            model = Model_1Factory.getModel();
        }
        catch(Exception e) {
            System.out.println("Can not initialize model repository " + e.getMessage());
            System.out.println(new ServiceException(e).getCause());
        }
        return model;
    }
        
    /**
     * Get persistence manager factory for local access.
     * 
     * @return
     * @throws NamingException
     * @throws ServiceException
     */
    public static PersistenceManagerFactory getPersistenceManagerFactory(
    ) throws ServiceException {
    	try {
    		return JDOHelper.getPersistenceManagerFactory("EntityManagerFactory");
    	} catch(Exception e) {
    		throw new ServiceException(e);
    	}
    }

    /**
     * Get persistence manager factory for local access.
     * 
     * @return
     * @throws NamingException
     * @throws ServiceException
     */
    public static PersistenceManagerFactory getPersistenceManagerFactory(
    	Map overrides
    ) throws ServiceException {
    	try {
    		return JDOHelper.getPersistenceManagerFactory(overrides, "EntityManagerFactory");
    	} catch(Exception e) {
    		throw new ServiceException(e);
    	}
    }

    /**
     * Get persistence manager factory for remote access.
     * 
     * @param url
     * @param userName
     * @param password
     * @param mimeType
     * @return
     * @throws NamingException
     * @throws ServiceException
     */
    public static PersistenceManagerFactory getPersistenceManagerFactoryProxy(
    	String url,
    	String userName,
    	String password,
    	String mimeType
    ) throws NamingException, ServiceException {
    	SimplePort port = new SimplePort();
    	port.setMimeType(mimeType == null ? "application/vnd.openmdx.wbxml" : mimeType);
    	port.setUserName(userName);
    	port.setPassword(password);
    	port.setConnectionURL(url);
    	org.openmdx.base.resource.cci.ConnectionFactory connectionFactory = new RestConnectionFactory(
        	port,
            true, // supportsLocalTransactionDemarcation
            TransactionAttributeType.NEVER
        );
        Map dataManagerProxyConfiguration = new HashMap();
        dataManagerProxyConfiguration.put(
            ConfigurableProperty.ConnectionFactory.qualifiedName(),
            connectionFactory
        );
        dataManagerProxyConfiguration.put(
            ConfigurableProperty.PersistenceManagerFactoryClass.qualifiedName(),
            org.openmdx.base.rest.connector.EntityManagerProxyFactory_2.class.getName()
        );
        PersistenceManagerFactory outboundConnectionFactory = JDOHelper.getPersistenceManagerFactory(
            dataManagerProxyConfiguration
        );
        Map entityManagerConfiguration = new HashMap();
        entityManagerConfiguration.put(
            ConfigurableProperty.ConnectionFactory.qualifiedName(),
            outboundConnectionFactory
        );
        entityManagerConfiguration.put(
            ConfigurableProperty.PersistenceManagerFactoryClass.qualifiedName(),
            EntityManagerFactory_1.class.getName()
        );    
        return JDOHelper.getPersistenceManagerFactory(entityManagerConfiguration);        
    }

    /**
     * Get persistence manager factory with given context name.
     * 
     * @param contextName
     * @return
     * @throws NamingException
     * @throws ServiceException
     */
    public static PersistenceManagerFactory getPersistenceManagerFactoryProxy(
    	String contextName
    ) throws NamingException, ServiceException {    	
    	// Data manager
        Map dataManagerConfiguration = new HashMap();
        dataManagerConfiguration.put(
            Constants.PROPERTY_CONNECTION_FACTORY_NAME,
            contextName == null ? "java:comp/env/ejb/EntityManagerFactory" : contextName
        );
        dataManagerConfiguration.put(
            Constants.PROPERTY_PERSISTENCE_MANAGER_FACTORY_CLASS,
            DataManager_2ProxyFactory.class.getName()
        );
        PersistenceManagerFactory dataManagerFactory = JDOHelper.getPersistenceManagerFactory(
        	dataManagerConfiguration
        );        
        // Entity manager
    	Map entityManagerConfiguration = new HashMap();
    	entityManagerConfiguration.put(
        	ConfigurableProperty.ConnectionFactory.qualifiedName(),
        	dataManagerFactory
        );
        entityManagerConfiguration.put(
        	ConfigurableProperty.PersistenceManagerFactoryClass.qualifiedName(),
        	EntityManagerFactory_1.class.getName()
        );        
        return JDOHelper.getPersistenceManagerFactory(entityManagerConfiguration);
    }

    /**
     * Get JMI package with given name.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static javax.jmi.reflect.RefPackage getJmiPackage(
        PersistenceManager pm,
        String authorityXri
    ) {
    	Authority obj = pm.getObjectById(
            Authority.class,
            authorityXri
        );  
    	return obj.refOutermostPackage().refPackage(obj.refGetPath().getLastSegment().toString());
    }

    /**
     * Get JMI package for org:opencrx:kernel:workflow1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static org.opencrx.kernel.workflow1.jmi1.Workflow1Package getWorkflowPackage(
        PersistenceManager pm
    ) {
        return (org.opencrx.kernel.workflow1.jmi1.Workflow1Package)getJmiPackage(
        	pm,
            org.opencrx.kernel.workflow1.jmi1.Workflow1Package.AUTHORITY_XRI
        );
    }

    /**
     * Get JMI package for org:opencrx:kernel:code1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static org.opencrx.kernel.code1.jmi1.Code1Package getCodePackage(
        PersistenceManager pm
    ) {
    	return (org.opencrx.kernel.code1.jmi1.Code1Package)getJmiPackage(
    		pm,
            org.opencrx.kernel.code1.jmi1.Code1Package.AUTHORITY_XRI
        );
    }

    /**
     * Get JMI package for org:opencrx:kernel:document1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static org.opencrx.kernel.document1.jmi1.Document1Package getDocumentPackage(
        PersistenceManager pm
    ) {
        return (org.opencrx.kernel.document1.jmi1.Document1Package)getJmiPackage(
        	pm,
            org.opencrx.kernel.document1.jmi1.Document1Package.AUTHORITY_XRI
        );
    }

    /**
     * Get JMI package for org:opencrx:kernel:admin1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static Admin1Package getAdminPackage(
        PersistenceManager pm
    ) {
        return (Admin1Package)getJmiPackage(
        	pm,
            Admin1Package.AUTHORITY_XRI
        );
    }

    /**
     * Get JMI package for org:openmdx:base.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static org.openmdx.base.jmi1.BasePackage getOpenMdxBasePackage(
        PersistenceManager pm
    ) {
        return (org.openmdx.base.jmi1.BasePackage)getJmiPackage(
        	pm,
        	org.openmdx.base.jmi1.BasePackage .AUTHORITY_XRI
         );
    }

    /**
     * Get JMI package for org:opencrx:security:home1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static Home1Package getHomePackage(
        PersistenceManager pm
    ) {
        return (Home1Package)getJmiPackage(
        	pm,
        	Home1Package.AUTHORITY_XRI
         );            
    }

    /**
     * Get JMI package for org:opencrx:security:contract1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static Contract1Package getContractPackage(
        PersistenceManager pm
    ) {
    	return (Contract1Package)getJmiPackage(
    		pm,
    		Contract1Package.AUTHORITY_XRI
    	);            
    }

    /**
     * Get JMI package for org:opencrx:security:depot1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static Depot1Package getDepotPackage(
        PersistenceManager pm
    ) {
        return (Depot1Package)getJmiPackage(
        	pm,
        	Depot1Package.AUTHORITY_XRI
        );
    }

    /**
     * Get JMI package for org:opencrx:kernel:building1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static Building1Package getBuildingPackage(
        PersistenceManager pm
    ) {
        return (Building1Package)getJmiPackage(
        	pm,
        	Building1Package.AUTHORITY_XRI
        );
    }

    /**
     * Get JMI package for org:opencrx:kernel:product1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static Product1Package getProductPackage(
        PersistenceManager pm
    ) {
        return (Product1Package)getJmiPackage(
        	pm,
        	Product1Package.AUTHORITY_XRI
        );
    }

    /**
     * Get JMI package for org:opencrx:kernel:uom1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static Uom1Package getUomPackage(
        PersistenceManager pm
    ) {
    	return (Uom1Package)getJmiPackage(
    		pm,
    		Uom1Package.AUTHORITY_XRI
    	);
    }

    /**
     * Get JMI package for org:opencrx:security:realm1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static Realm1Package getRealmPackage(
        PersistenceManager pm
    ) {
        return (Realm1Package)getJmiPackage(
        	pm,
        	Realm1Package.AUTHORITY_XRI
        );
    }

    /**
     * Get JMI package for org:opencrx:kernel:base.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static org.opencrx.kernel.base.jmi1.BasePackage getBasePackage(
        PersistenceManager pm
    ) {
        return (org.opencrx.kernel.base.jmi1.BasePackage)getJmiPackage(
        	pm,
        	org.opencrx.kernel.base.jmi1.BasePackage.AUTHORITY_XRI
        );
    }

    /**
     * Get JMI package for org:opencrx:kernel:activity1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static Activity1Package getActivityPackage(
        PersistenceManager pm
    ) {
        return (Activity1Package)getJmiPackage(
        	pm,
        	Activity1Package.AUTHORITY_XRI
        );
    }

    /**
     * Get JMI package for org:opencrx:kernel:account1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static Account1Package getAccountPackage(
        PersistenceManager pm
    ) {
        return (Account1Package)getJmiPackage(
        	pm,
        	Account1Package.AUTHORITY_XRI
        );
    }

    /**
     * Get JMI package for org:opencrx:kernel:forecast1.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static Forecast1Package getForecastPackage(
        PersistenceManager pm
    ) {
        return (Forecast1Package)getJmiPackage(
        	pm,
        	Forecast1Package.AUTHORITY_XRI
        );
    }

    /**
     * Get JMI package for org:opencrx:kernel:generic.
     * 
     * @param pm
     * @return
     * @deprecated use PersistenceManager.newInstance(), PersistenceManager.newQuery(), Structures.create() instead. 
     */
    @Deprecated
    public static GenericPackage getGenericPackage(
        PersistenceManager pm
    ) {
        return (GenericPackage)getJmiPackage(
        	pm,
        	GenericPackage.AUTHORITY_XRI
        );
    }

    /**
     * Map string to a valid file name.
     * 
     * @param s
     * @return
     */
    public static String toFilename(
        String s
    ) {
        s = s.replace(' ', '-');
        s = s.replace(',', '-');
        s = s.replace('/', '-');
        s = s.replace('\\', '-');
        s = s.replace('=', '-');
        s = s.replace('%', '-');
        s = s.replace(':', '-');
        s = s.replace('*', '-');
        s = s.replace('?', '-');
        s = s.replace('+', '-');
        s = s.replace('(', '-');
        s = s.replace(')', '-');
        s = s.replace('<', '-');
        s = s.replace('>', '-');
        s = s.replace('|', '-');
        s = s.replace('"', '-');
        s = s.replace('\'', '-');
        s = s.replace('&', '-');
        s = s.replace('.', '-');
        s = s.replace('#', '-');
        s = s.replace("-", "");
        if(s.length() > 50) {
            s = s.substring(0, 44) + s.substring(s.length()-5);
        }
        return s;
    }
        
    /**
     * Get digest for given password.
     * 
     * @param password
     * @param algorithm
     * @return
     */
    public static String getPasswordDigest(
        String password,
        String algorithm
    ) {
        try {
            MessageDigest md = MessageDigest.getInstance(algorithm);
            md.update(password.getBytes("UTF-8"));
            return "{" + algorithm + "}" + org.openmdx.base.text.conversion.Base64.encode(md.digest());
        }
        catch(NoSuchAlgorithmException e) {
        }
        catch(UnsupportedEncodingException e) {
        }
        return null;
    }
    
    /**
     * Returns true if the two values are equal.
     * 
     * @param v1
     * @param v2
     * @return
     */
    @SuppressWarnings("unchecked")
    public static boolean areEqual(
        Object v1,
        Object v2
    ) {
        if(
            (v1 instanceof Comparable) && 
            (v2 instanceof Comparable) &&
            (v1.getClass().equals(v2.getClass()))
        ) {
            return ((Comparable)v1).compareTo(v2) == 0;
        }
        return Objects.equals(v1,  v2);
    }

    /**
     * Get uom scale factor.
     * 
     * @param from
     * @param to
     * @return
     */
    public static BigDecimal getUomScaleFactor(
        org.opencrx.kernel.uom1.jmi1.Uom from,
        org.opencrx.kernel.uom1.jmi1.Uom to
    ) {
        if(from == null || to == null) {
            return BigDecimal.ZERO;
        }
        else if(from.refMofId().equals(to.refMofId())) {
            return BigDecimal.ONE;
        }
        else if(
            (from.getBaseUom() != null) && 
            from.getBaseUom().refMofId().equals(to.refMofId())
        ) {
            return from.getQuantity() != null ? 
            	from.getQuantity() : 
            	BigDecimal.ZERO;
        }
        else if(
            (to.getBaseUom() != null) && 
            to.getBaseUom().refMofId().equals(from.refMofId())
        ) {
            return (to.getQuantity() != null) && (to.getQuantity().signum() != 0) ? 
            	new BigDecimal(1.0 / to.getQuantity().doubleValue()) : 
            	BigDecimal.ZERO;
        }
        else if(
            (from.getBaseUom() != null) && 
            (to.getBaseUom() != null) && 
            from.getBaseUom().refMofId().equals(to.getBaseUom().refMofId())
        ) {
            return (from.getQuantity() != null) && (to.getQuantity() != null) && (to.getQuantity().signum() != 0) ? 
            	new BigDecimal(from.getQuantity().doubleValue() / to.getQuantity().doubleValue()) : 
            	BigDecimal.ZERO;
        }
        else {
            return BigDecimal.ZERO;
        }
    }

    /**
     * Get localized date format.
     * 
     * @param userHome
     * @return
     */
    public static SimpleDateFormat getLocalizedDateFormat(
    	UserHome userHome
    ) {
    	// User settings
    	Properties userSettings = new Properties();
		try {
	    	if(userHome != null && userHome.getSettings() != null) {
	    		userSettings.load(
	    			new ByteArrayInputStream(
	    				userHome.getSettings().getBytes("UTF-8")
	    			)
	    	    );
	    	}
		}
		catch(Exception e) {}
		// Locale
		Locale userLocale = Locale.getDefault();
		if(userSettings.getProperty(UserSettings.LOCALE_NAME.getName()) != null) {
			String localeAsString = userSettings.getProperty(UserSettings.LOCALE_NAME.getName()); 
	        userLocale = new Locale(
	        	localeAsString.substring(0, 2), 
	        	localeAsString.substring(localeAsString.indexOf("_") + 1)
	        );
		}		
    	SimpleDateFormat dateTimeFormat = (SimpleDateFormat)SimpleDateFormat.getDateTimeInstance(
        	java.text.DateFormat.SHORT,
        	java.text.DateFormat.MEDIUM,
        	userLocale
        );
        DateValue.assert4DigitYear(dateTimeFormat);
        // TimeZone
		if(userSettings.getProperty(UserSettings.TIMEZONE_NAME.getName()) != null) {
			try {
	    		dateTimeFormat.setTimeZone(
	    			TimeZone.getTimeZone(
	    				userSettings.getProperty(UserSettings.TIMEZONE_NAME.getName())
	    			)
	            );
    		}
	    	catch(Exception e) {}
    	}
    	return dateTimeFormat;
    }
    	
    /**
     * Callback interface for traverseObjectTree method.
     *
     */
    public interface TraverseObjectTreeCallback {
    
    	public Object visit(
    		RefObject_1_0 object,
    		Object context
    	) throws ServiceException;
    	
    }
    
    /**
     * Get UUID.
     * 
     * @return
     */
    public static String getUidAsString(
    ) {
        return UUIDConversion.toUID(UUIDs.newUUID());        
    }

    /**
     * Model-driven, recursive traversal of object tree.
     * 
     * @param object
     * @param referenceFilter
     * @param callback
     * @param context
     * @return
     * @throws ServiceException
     */
    public static Object traverseObjectTree(
    	RefObject_1_0 object,
        Set referenceFilter,
        TraverseObjectTreeCallback callback,
        Object context
    ) throws ServiceException {
    	Object newContext = callback.visit(
    		object,
    		context
    	);
        Model_1_0 model = Model_1Factory.getModel();
        Map references = model.getElement(
        	object.refClass().refMofId()
        ).objGetMap("reference");
        for(ModelElement_1_0 featureDef: references.values()) {
            ModelElement_1_0 referencedEnd = model.getElement(
                featureDef.getReferencedEnd()
            );
            boolean referenceIsCompositeAndChangeable = 
                model.isReferenceType(featureDef) &&
                AggregationKind.COMPOSITE.equals(referencedEnd.getAggregation()) &&
                ((Boolean)referencedEnd.isChangeable()).booleanValue();
            boolean referenceIsSharedAndChangeable = 
                model.isReferenceType(featureDef) &&
                AggregationKind.SHARED.equals(referencedEnd.getAggregation()) &&
                ((Boolean)referencedEnd.isChangeable()).booleanValue();            
            // Only navigate changeable references which are either 'composite' or 'shared'
            // Do not navigate references with aggregation 'none'.
            if(referenceIsCompositeAndChangeable || referenceIsSharedAndChangeable) {
                String referenceName = (String)featureDef.getName();
                boolean matches = referenceFilter == null;
                if(!matches) {
                    String qualifiedReferenceName = (String)featureDef.getQualifiedName();
                    matches =
                        referenceFilter.contains(referenceName) ||
                        referenceFilter.contains(qualifiedReferenceName);
                }
                if(matches) {   
                	PersistenceManager pm = JDOHelper.getPersistenceManager(object);
                	javax.jdo.Query query = null;
                	try {
	            		Query_2Facade queryFacade = Query_2Facade.newInstance(object.refGetPath().getDescendant(referenceName));
	            		ModelElement_1_0 referencedType = model.getElement(referencedEnd.getType());
	            		queryFacade.setQueryType(referencedType.getQualifiedName());
	            		query = pm.newQuery(
	            			Queries.QUERY_LANGUAGE,
	            			queryFacade.getDelegate()
	            		);
	            		query.getFetchPlan().setGroup(FetchGroup.ALL);
                	} catch(Exception e) {
                		throw new ServiceException(e);
                	}
                    List content = ((RefContainer)object.refGetValue(referenceName)).refGetAll(query);
                    for(Object contained: content) {
                        traverseObjectTree(
                            (RefObject_1_0)contained,
                            referenceFilter,
                            callback,
                            newContext
                        );
                    }
                }
            }
        }	
        return newContext;
    }

    /**
     * Get principal assigned to pm.
     * 
     * @param pm
     * @param providerName
     * @param segmentName
     * @return
     */
    public static org.openmdx.security.realm1.jmi1.Principal getRequestingPrincipal(
    	PersistenceManager pm,
    	String providerName,
    	String segmentName
    ) {
    	List principalChain = UserObjects.getPrincipalChain(pm);
    	if(principalChain.isEmpty()) return null;
    	return (org.openmdx.security.realm1.jmi1.Principal)pm.getObjectById(
			new Path("xri://@openmdx*org.openmdx.security.realm1").getDescendant("provider", providerName, "segment", "Root", "realm", segmentName, "principal", principalChain.get(0))
        );
    }

    /**
     * Get user assigned to pm.
     * 
     * @param pm
     * @param providerName
     * @param segmentName
     * @return
     */
    public static org.opencrx.security.realm1.jmi1.User getRequestingUser(
    	PersistenceManager pm,
    	String providerName,
    	String segmentName
    ) {
    	List principalChain = UserObjects.getPrincipalChain(pm);
    	if(principalChain.isEmpty()) return null;
    	return (org.opencrx.security.realm1.jmi1.User)pm.getObjectById(
    		new Path("xri://@openmdx*org.openmdx.security.realm1").getDescendant("provider", providerName, "segment", "Root", "realm", segmentName, "principal", principalChain.get(0) + "." + SecurityKeys.USER_SUFFIX)
    	);
    }

    /**
     * Return true if principal is member of at least one of the given groups.
     * 
     * @param principal
     * @param principalGroups
     * @return
     */
    public static boolean principalIsMemberOf(
    	org.openmdx.security.realm1.jmi1.Principal principal,
    	String... principalGroups
    ) {
    	if(principal != null && principalGroups != null) {
	    	List groups = Arrays.asList(principalGroups);
	    	Collection memberships = principal.getIsMemberOf();
	    	for(org.openmdx.security.realm1.jmi1.Group membership: memberships) {
	    		if(groups.contains(membership.getName())) {
	    			return true;
	    		}
	    	}
    	}
    	return false;
    }

    /**
     * Get permissions for given action and principal.
     * 
     * @param principal
     * @param action
     * @return
     * @throws ServiceException
     */
    public static List getPermissions(
    	org.openmdx.security.realm1.jmi1.Principal principal,
    	String action
    ) throws ServiceException {
    	List permissions = new ArrayList();
    	if(principal instanceof org.opencrx.security.realm1.jmi1.Principal) {
			List roles = ((org.opencrx.security.realm1.jmi1.Principal)principal).getGrantedRole();
			for(Role role: roles) {
				for(Permission permission: role.getPermission()) {
					if(permission.getAction().contains(action)) {
						permissions.add(permission.getName());
					}
				}
			}
    	}
		return permissions;
    }
    
    /**
     *  Checks whether there exists a permission matching the pattern
     *  'object:authority/object path@runAsPrincipal'
     * @param objectIdentity
     * @param runAsPermissions
     * @return
     */
    public static boolean hasObjectRunAsPermission(
    	Path objectIdentity,
    	List runAsPermissions
    ) {
    	for(String runAsPermission: runAsPermissions) {
    		if(runAsPermission.startsWith("object:")) {
    			String[] components = runAsPermission.substring(7, runAsPermission.indexOf("@")).split("/");
    			if(components.length > 0) {
    				Path pattern = new Path("xri://@openmdx*" + components[0]).getDescendant("provider", objectIdentity.get(2), "segment", objectIdentity.get(4));
    				for(int j = 1; j < components.length; j++) {
    					pattern = pattern.getDescendant(components[j]);
    				}
            		if(objectIdentity.isLike(pattern)) {
            			return true;
            		}
    			}
    		}
    	}
    	return false;
    }

    /**
     * Return a localized dateTime formatter.
     * @param language
     * @return
     */
    public static DateFormat getTimeFormat(
        String language
    ) {
        Map timeFormatters = cachedTimeFormat.get();
        DateFormat timeFormat = timeFormatters.get(language);
        if(timeFormat == null) {
            timeFormat = DateFormat.getTimeInstance(DateFormat.SHORT, new Locale(language)); 
            timeFormatters.put(
                language,
                timeFormat
            );
        }
        return timeFormat; 
    }
    
    /**
     * Return a localized decimal formatter.
     * @param language
     * @return
     */
    public static DecimalFormat getDecimalFormat(
        String language
    ) {
        Map decimalFormatters = cachedDecimalFormat.get();
        DecimalFormat decimalFormat = decimalFormatters.get(language);
        if(decimalFormat == null) {
            decimalFormat = (DecimalFormat)DecimalFormat.getInstance(new Locale(language)); 
            decimalFormatters.put(
                language,
                decimalFormat
            );
        }
        return decimalFormat; 
    }

    /**
     * Return a localized date formatter.
     * @param language
     * @return
     */
    public static DateFormat getDateFormat(
        String language
    ) {
        Map dateFormatters = cachedDateFormat.get();
        DateFormat dateFormat = dateFormatters.get(language);
        if(dateFormat == null) {
            dateFormat = DateFormat.getDateInstance(DateFormat.SHORT, new Locale(language));
            dateFormatters.put(
                language,
                dateFormat
            );
        }
        return dateFormat;
    }
        
    /**
     * Normalize new lines in given string. Patterns of the form (\r\n|\r|\n)
     * are replaced by \n
     * @param s
     * @return
     */
    public static String normalizeNewLines(
    	String s
    ) {
    	Matcher m = CRLF.matcher(s);
    	if(m.find()) {
    		return m.replaceAll("\\\n");
    	} else {
    		return s;
    	}
    }

    /**
     * Split string.
     * 
	 * @param text
	 * @param size
	 * @return
	 */
	public static List splitString(
		String text, 
		int size
	) {
		// Give the list the right capacity to start with. You could use an array instead if you wanted.
		if (text == null) {
			text = "";
		}
		List ret = new ArrayList((text.length() + size - 1) / size);
	
		for (int start = 0; start < text.length(); start += size) {
			ret.add(text.substring(start, Math.min(text.length(), start + size)));
		}
		return ret;
	}

    /**
     * Touch object. This way jdoPreStore() will be invoked.
     * 
     * @param object
     * @throws ServiceException
     */
    public static void touchObject(
        RefObject object
    ) throws ServiceException {
    	DirtyObjects.touch(object);
    }

    /**
     * Get a base62 random string of given length.
     * 
     * @param length
     * @return
     */
    public static String getRandomBase62(
    	int length
    ) {
    	final String alphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
    	final Random random = new SecureRandom();
    	String s = "";
    	for(int i = 0; i < length; i++) {
    		s += alphabet.charAt(random.nextInt(62));
    	}
    	return s;
    }

    /**
     * Return true if object is instance of given type.
     * 
     * @param object
     * @param qualifiedTypeName
     * @return
     * @throws ServiceException
     */
    public static boolean isInstanceOf(
    	MappedRecord object,
    	String qualifiedTypeName
    ) throws ServiceException {
    	Model_1_0 model = Utils.getModel();
        String objectClass = Object_2Facade.getObjectClass(object);
        return model.isSubtypeOf(
            objectClass,
            qualifiedTypeName
        );
    }

    /**
     * Return value rounded by rounding factor.
     * 
     * @param value
     * @param roundingFactor
     * @return
     */
    public static BigDecimal round(
    	BigDecimal value,
    	BigDecimal roundingFactor
    ) {
    	if(roundingFactor == null || BigDecimal.ZERO.equals(roundingFactor)) {
    		return value;
    	} else {
	        return new BigDecimal(value
	        	.divide(roundingFactor, MathContext.DECIMAL64)
	        	.add(new BigDecimal((float)value.signum() * 0.5f), MathContext.DECIMAL64)
				.toBigInteger())
				.multiply(roundingFactor, MathContext.DECIMAL64);
    	}
    }

    /**
     * Get persistence configuration.
     * 
     * @param name
     * @return
     * @throws ServiceException
     */
    public static Configuration getPersistenceConfiguration(
        String name
    ) throws ServiceException {
        try {
            return Configurations.getDataproviderConfigurationProvider(
                PropertiesProvider.getProperties(Resources.toMetaInfXRI(name + ".properties"))
            ).getSection(
                Collections.singletonMap("class",Database_2.class.getName()),
                "PERSISTENCE",
                Collections.emptyMap()
            );
        } catch (IOException exception) {
            throw new ServiceException(exception);
        }
    }

    /**
     * Get database plugin with given configuration name.
     * 
     * @param name
     * @return
     * @throws ServiceException
     */
    public static Database_2_0 newDatabasePlugIn(
        String name
    ) throws ServiceException {
        try {
            Factory plugInFactory = PlugInFactory.newInstance(
                Database_2_0.class,
                getPersistenceConfiguration(name)
            );
            return plugInFactory.instantiate();
        } catch (RuntimeException exception) {
            throw new ServiceException(exception);
        }
    }
   
    /**
     * Get database plug-ins configuration.
     *
     * @return
     */
    public static Database_2[] getDatabasePlugIns(
    ) throws ServiceException {
        if(DbSchemaUtils.databasePlugIns == null) {
            // Prepare database plugins for namespace Kernel and Security
            Database_2 kernelDb = (Database_2) newDatabasePlugIn("Kernel");
            Database_2 securityDb = (Database_2) newDatabasePlugIn("Security");
            DbSchemaUtils.databasePlugIns = new Database_2[]{kernelDb, securityDb};
        }
        return DbSchemaUtils.databasePlugIns;
    }
    
    //-------------------------------------------------------------------------
    // Members
	//-------------------------------------------------------------------------
    private static Pattern CRLF = Pattern.compile("(\r\n|\r|\n)");

    private static ThreadLocal> cachedDateFormat = new ThreadLocal>() {
        protected synchronized Map initialValue() {
            return new HashMap();
        }
    };
    private static ThreadLocal> cachedTimeFormat = new ThreadLocal>() {
        protected synchronized Map initialValue() {
            return new HashMap();
        }
    };
    private static ThreadLocal> cachedDecimalFormat = new ThreadLocal>() {
        protected synchronized Map initialValue() {
            return new HashMap();
        }
    };
    
}

//--- End of File -----------------------------------------------------------
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy