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.
package org.fax4j.spi.adapter;
import java.io.File;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import org.fax4j.FaxException;
import org.fax4j.common.Logger;
import org.fax4j.spi.FaxClientSpiFactory;
import org.fax4j.util.ReflectionHelper;
/**
* This class implements the fax client service provider interface.
* This implementation will proxy the requests to another internal SPI.
* The internal SPI created will be based on configuration in the fax4j properties.
* The configuration contains conditions such as OS, availability of java classes,
* availability of native libraries, availability of executables or validation that
* a certain fax4j property is defined and contains a value.
* Once all conditions are met the internal SPI is created, otherwise the next SPI configuration
* is used.
* If no SPI conditions are met, an exception will be thrown.
*
* The configuration of the fax4j framework is made up of 3 layers.
* The configuration is based on simple properties.
* Each layer overrides the lower layers by adding/changing the property values.
* The first layer is the internal fax4j.properties file located in the fax4j jar.
* This layer contains the preconfigured values for the fax4j framework and can be changed
* by updating these properties in the higher layers.
* The second layer is the external fax4j.properties file that is located on the classpath.
* This file is optional and provides the ability to override the internal configuration for the
* entire fax4j framework.
* The top most layer is the optional java.util.Properties object provided by the external classes
* when creating a new fax client.
* These properties enable to override the configuration of the lower 2 layers.
*
* SPI Status (Draft, Beta, Stable): Stable
*
* Below table describes the configuration values relevant for this class.
* Configuration:
*
*
*
Name
*
Description
*
Preconfigured Value
*
Default Value
*
Mandatory
*
*
*
org.fax4j.spi.adapter.internal.spi.types
*
A ';' seperated list of SPI types.
* This SPI will go over the list one by one based on the configured order and will validate the type
* conditions.
* Once an SPI is found for which all conditions are met, the adapter SPI will create an instance
* of it and use it to proxy all fax operations to.
*
For each type defined in the org.fax4j.spi.adapter.internal.spi.types property, you can define custom
* conditions to validate.
* These conditions include:
* property - checks a fax4j property is defined and contains a value
* OS - checks OS name contains the value (case insensitive)
* java-class - checks that java class can be loaded
* native-lib - checks that native lib can be loaded
* executable - checks executable is on system path
* stable - checks for a fax4j property org.fax4j.spi.xxx.stable is defined and equals true, where xxx is the SPI key (for example: org.fax4j.spi.adapter.stable=true)
* Conditions are separated by a ';' character and the condition type and value are seperated by the ':'
* character, for example:
* org.fax4j.spi.adapter.internal.spi.condition.vbs=OS:windows;executable:cscript.exe
* The following conditions are always checked (even if not defined):
*
*
property:org.fax4j.spi.type.map.xxx where xxx is the SPI key (for example: org.fax4j.spi.type.map.adapter)
*
java-class:xxx where xxx is the SPI class name based on the fax4j mapping (for example: org.fax4j.spi.type.map.adapter=org.fax4j.spi.adapter.AdapterFaxClientSpi)
*
The adapter SPI enables to override the fax4j configuration for the internal SPI,
* by defining org.fax4j.spi.adapter.configuration.override.xxx properties where xxx is the original property name for example:
* org.fax4j.spi.adapter.configuration.override.org.fax4j.proxy.enabled=false overrides the org.fax4j.proxy.enabled property for
* the interal SPI.
*
*
*
* @author Sagie Gur-Ari
* @version 1.16
* @since 0.1
*/
public class AdapterFaxClientSpi extends AbstractAdapterFaxClientSpi
{
/**
* This class holds the SPI configuration constants.
*
* @author Sagie Gur-Ari
* @version 1.02
* @since 0.1
*/
public enum FaxClientSpiConfigurationConstants
{
/**The SPI types property key (SPI type list separated by ;)*/
SPI_TYPES_PROPERTY_KEY("org.fax4j.spi.adapter.internal.spi.types"),
/**The SPI condition property key prefix*/
SPI_CONDITION_PROPERTY_KEY_PREFIX("org.fax4j.spi.adapter.internal.spi.condition."),
/**The SPI stable property key prefix*/
SPI_STABLE_PROPERTY_KEY_PREFIX("org.fax4j.spi."),
/**The SPI stable property key suffix*/
SPI_STABLE_PROPERTY_KEY_SUFFIX(".stable"),
/**The SPI configuration override property key prefix*/
SPI_CONFIGURATION_OVERRIDE_PROPERTY_KEY_PREFIX("org.fax4j.spi.adapter.configuration.override."),
/**The property value list separator ';'*/
PROPERTY_VALUE_LIST_SEPARATOR(";"),
/**The property value separator ':'*/
PROPERTY_BLOCK_VALUE_SEPARATOR(":"),
/**The property condition - checks a fax4j property is defined and contains a value*/
PROPERTY_CONDITION("property"),
/**The OS condition - checks OS name contains the value (case insensitive)*/
OS_CONDITION("OS"),
/**The java class condition - checks that java class can be loaded*/
JAVA_CLASS_CONDITION("java-class"),
/**The native lib condition - checks that native lib can be loaded*/
NATIVE_LIB_CONDITION("native-lib"),
/**The executable condition - checks executable is on system path*/
EXECUTABLE_CONDITION("executable"),
/**The stable condition - checks for a fax4j property org.fax4j.spi.xxx.stable is defined and equals true, where xxx is the SPI key (for example: org.fax4j.spi.adapter.stable=true)*/
STABLE_CONDITION("stable");
/**The string value*/
private String value;
/**
* This is the class constructor.
*
* @param value
* The string value
*/
private FaxClientSpiConfigurationConstants(String value)
{
this.value=value;
}
/**
* This function returns the string value.
*
* @return The string value
*/
@Override
public final String toString()
{
return this.value;
}
/**
* This function returns the enum for the provided value.
*
* @param value
* The value to search for
* @return The enum
*/
public static FaxClientSpiConfigurationConstants getEnum(String value)
{
if(value==null)
{
throw new FaxException("Null value provided.");
}
FaxClientSpiConfigurationConstants[] values=FaxClientSpiConfigurationConstants.values();
int amount=values.length;
FaxClientSpiConfigurationConstants constant=null;
for(int index=0;index
* property - checks a fax4j property is defined and contains a value
* OS - checks OS name contains the value (case insensitive)
* java-class - checks that java class can be loaded
* native-lib - checks that native lib can be loaded
* executable - checks executable is on system path
* stable - checks for a fax4j property org.fax4j.spi.xxx.stable is defined and equals true, where xxx is the SPI key (for example: org.fax4j.spi.adapter.stable=true)
* @param value
* The condition value
* @return True if the condition is met
*/
protected boolean validateCondition(String key,String value)
{
boolean valid=false;
FaxClientSpiConfigurationConstants condition=FaxClientSpiConfigurationConstants.getEnum(key);
String propertyValue=null;
switch(condition)
{
case PROPERTY_CONDITION:
//get value
propertyValue=this.getConfigurationValue(value);
if(propertyValue!=null)
{
valid=true;
}
break;
case OS_CONDITION:
//get OS name
String osName=System.getProperty("os.name");
//change values to lower case
osName=osName.toLowerCase();
String updatedValue=value.toLowerCase();
if(osName.contains(updatedValue))
{
valid=true;
}
break;
case JAVA_CLASS_CONDITION:
try
{
//load class
ReflectionHelper.getType(value);
valid=true;
}
catch(Throwable throwable)
{
//ignore
}
break;
case NATIVE_LIB_CONDITION:
try
{
//load library
System.loadLibrary(value);
valid=true;
}
catch(Throwable throwable)
{
//ignore
}
break;
case EXECUTABLE_CONDITION:
//get system path
String systemPath=System.getProperty("java.library.path");
String[] systemPathElements=systemPath.split(System.getProperty("path.separator"));
//get amount
int amount=systemPathElements.length;
String directoryPath=null;
File file=null;
for(int index=0;index configuration=this.getConfiguration();
//create new configuration
Properties internalSPIConfiguration=new Properties();
Properties overrideConfiguration=new Properties();
//go over current configuration
Iterator> iterator=configuration.entrySet().iterator();
Entry entry=null;
String key=null;
String value=null;
String overrideKey=null;
String overridePrefix=FaxClientSpiConfigurationConstants.SPI_CONFIGURATION_OVERRIDE_PROPERTY_KEY_PREFIX.toString();
int prefixLength=overridePrefix.length();
while(iterator.hasNext())
{
//get next entry
entry=iterator.next();
//get key/value
key=entry.getKey();
value=entry.getValue();
//override internal configuration
if((key.startsWith(overridePrefix)))
{
if(key.length()!=prefixLength)
{
overrideKey=key.substring(prefixLength);
//put in override configuration
overrideConfiguration.setProperty(overrideKey,value);
}
}
//put in new configuration
internalSPIConfiguration.setProperty(key,value);
}
//override configuration
internalSPIConfiguration.putAll(overrideConfiguration);
return internalSPIConfiguration;
}
}
