org.ops4j.pax.web.service.spi.util

Class Utils

java.lang.Object

org.ops4j.pax.web.service.spi.util.Utils

public class Utils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method and Description
static Boolean	asBoolean(String propertyName, Object value)
static Integer	asInteger(String propertyName, Object value)
static Long	asLong(String propertyName, Object value)
static String	asString(String propertyName, Object value)
static String[]	asStringArray(String propertyName, Object value) Helper method to convert generic property value into array of Strings.
static String[]	asStringArray(String propertyName, Object value, boolean splitStrings) Helper method to convert generic property value into array of Strings.
static org.osgi.framework.Filter	createFilter(org.osgi.framework.BundleContext bundleContext, Class<?>... trackedClass) Creates a Filter based on a non-empty list of classes.
static Boolean	getBooleanProperty(org.osgi.framework.ServiceReference<?> serviceReference, String key) Get a property which can be specified as String or Boolean and return it as Boolean.
static String	getFirstObjectClass(org.osgi.framework.ServiceReference<?> ref) Returns first available Constants.OBJECTCLASS property value from ServiceReference or null if not available (but it should be).
static OsgiContextModel	getHighestRankedModel(Set<OsgiContextModel> rankedSet) Gets first OsgiContextModel from ranked set or null if not available.
static Integer	getIntegerProperty(org.osgi.framework.ServiceReference<?> serviceReference, String key) Returns a service property as Integer.
static org.osgi.framework.Bundle	getJettyWebSocketBundle(org.osgi.framework.Bundle bundle) Specialized method that's used to add Jetty WebSocket bundle that we know to contain required ServletContainerInitializer services.
static Long	getLongProperty(org.osgi.framework.ServiceReference<?> serviceReference, String key) Returns a service property as Long.
static String	getManifestHeader(org.osgi.framework.Bundle bundle, String key) Returns a named header from a bundle or from one of its attached fragments
static String[]	getObjectClasses(org.osgi.framework.ServiceReference<?> ref) Returns all Constants.OBJECTCLASS property values from ServiceReference
static org.osgi.framework.Bundle	getPaxWebJspBundle(org.osgi.framework.Bundle bundle)
static org.osgi.framework.Bundle	getPaxWebJspBundle(org.osgi.framework.BundleContext bundleContext)
static <T> T	getPaxWebProperty(org.osgi.framework.ServiceReference<?> serviceReference, String legacyName, String whiteboardName, BiFunction<String,Object,T> propertyProvider) Gets a service property by checking legacy and whiteboard property names, printing relevant warnings, if needed.
static org.osgi.framework.Bundle	getPaxWebUndertowWebSocketBundle(org.osgi.framework.Bundle bundle) Specialized method that's used to add Undertow WebSocket bundle that we know to contain required ServletContainerInitializer services
static org.osgi.framework.Bundle	getPaxWebWebSocketsBundle(org.osgi.framework.Bundle bundle) Find Pax Web bundle for generic (Whiteboard and HttpService) support for WebSockets
static long	getServiceId(org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> ref) Returns Constants.SERVICE_ID or -1 if not available
static String	getStringProperty(org.osgi.framework.ServiceReference<?> serviceReference, String key) Returns a service property as String.
static org.osgi.framework.Bundle	getTomcatWebSocketBundle(org.osgi.framework.Bundle bundle) Specialized method that's used to add Tomcat WebSocket bundle that we know to contain required ServletContainerInitializer services
static org.osgi.framework.Bundle	getUndertowWebSocketBundle(org.osgi.framework.Bundle bundle) Specialized method that's used to add Undertow WebSocket bundle that we know to contain required ServletContainerInitializer services
static boolean	isBundleProtocol(URL url) Checks whether given URL uses protocol used by Bundle.getResource(String) (at least for Felix and Equinox).
static boolean	isConfigurationAdminAvailable(Class<?> cls)
static boolean	isDirectory(URL location) Checks if given location is a directory
static boolean	isEventAdminAvailable(Class<?> cls) Check if org.osgi.service.event.EventAdmin is available
static boolean	isFragment(org.osgi.framework.Bundle bundle) Checkes whether a Bundle is a fragment bundle.
static boolean	isJasyptAvailable(Class<?> cls) Check if Jasypt bundle is available
static String	resolve(Map<String,String> properties, String value, String defaultValue)
static String	resolve(String value)
static String	resolve(String value, String defaultValue)
static boolean	same(Dictionary<String,?> cfg1, Dictionary<String,?> cfg2)
static boolean	same(Object v1, Object v2)
static Hashtable<String,Object>	toHashtable(Dictionary<String,?> dictionary)
static Map<String,String>	toMap(Dictionary<?,?> dictionary) Helper method to convert incoming Dictionary with unspecified types to map of Strings.
static Map<String,String>	toMap(org.osgi.framework.ServiceReference<?> reference) Special method to be called from R6 framwork (ServiceReference#getProperties() was added in R7 == org.osgi.framework;version=1.9).
static boolean	useSameContextPath(ElementModel<?,?> model1, ElementModel<?,?> model2) Returns true if two elements models use at least one OsgiContextModel referring to the same cotext path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

public static final org.slf4j.Logger LOG

Method Detail

same

public static boolean same(Dictionary<String,?> cfg1,
                           Dictionary<String,?> cfg2)

same

public static boolean same(Object v1,
                           Object v2)

toMap

public static Map<String,String> toMap(Dictionary<?,?> dictionary)

Helper method to convert incoming Dictionary with unspecified types to map of Strings.

Especially useful when translating from ConfigurationAdmin configs to maps specified at e.g., ServletConfig.getInitParameterNames().

Parameters:

dictionary - dictionary of potentially diffent types of keys and values

Returns:

map of Strings

toHashtable

public static Hashtable<String,Object> toHashtable(Dictionary<String,?> dictionary)

toMap

public static Map<String,String> toMap(org.osgi.framework.ServiceReference<?> reference)

Special method to be called from R6 framwork (ServiceReference#getProperties() was added in R7 == org.osgi.framework;version=1.9).

Parameters:

reference -

Returns:

resolve

public static String resolve(String value)

resolve

public static String resolve(String value,
                             String defaultValue)

resolve

public static String resolve(Map<String,String> properties,
                             String value,
                             String defaultValue)

getServiceId

public static long getServiceId(org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> ref)

Returns Constants.SERVICE_ID or -1 if not available

Parameters:

ref -

Returns:

createFilter

public static org.osgi.framework.Filter createFilter(org.osgi.framework.BundleContext bundleContext,
                                                     Class<?>... trackedClass)

Creates a Filter based on a non-empty list of classes.

Parameters:

bundleContext -

trackedClass -

Returns:

getObjectClasses

public static String[] getObjectClasses(org.osgi.framework.ServiceReference<?> ref)

Returns all Constants.OBJECTCLASS property values from ServiceReference

Parameters:

ref -

Returns:

getFirstObjectClass

public static String getFirstObjectClass(org.osgi.framework.ServiceReference<?> ref)

Returns first available Constants.OBJECTCLASS property value from ServiceReference or null if not available (but it should be).

Parameters:

ref -

Returns:

getStringProperty

public static String getStringProperty(org.osgi.framework.ServiceReference<?> serviceReference,
                                       String key)

Returns a service property as String.

Parameters:

serviceReference - service reference; cannot be null

key - property key; cannot be null

Returns:

property value; null if property is not set or property value is not a String

Throws:

IllegalArgumentException - - If service reference is null or if key is null

asString

public static String asString(String propertyName,
                              Object value)

getIntegerProperty

public static Integer getIntegerProperty(org.osgi.framework.ServiceReference<?> serviceReference,
                                         String key)

Returns a service property as Integer.

Parameters:

serviceReference - service reference; cannot be null

key - property key; cannot be null

Returns:

property value; null if property is not set or property value is not a Integer

Throws:

IllegalArgumentException - - If service reference is null or if key is null

asInteger

public static Integer asInteger(String propertyName,
                                Object value)

getLongProperty

public static Long getLongProperty(org.osgi.framework.ServiceReference<?> serviceReference,
                                   String key)

Returns a service property as Long.

Parameters:

serviceReference - service reference; cannot be null

key - property key; cannot be null

Returns:

property value; null if property is not set or property value is not a Long

Throws:

IllegalArgumentException - - If service reference is null or if key is null

asLong

public static Long asLong(String propertyName,
                          Object value)

getBooleanProperty

public static Boolean getBooleanProperty(org.osgi.framework.ServiceReference<?> serviceReference,
                                         String key)

Get a property which can be specified as String or Boolean and return it as Boolean.

Parameters:

serviceReference -

key -

Returns:

asBoolean

public static Boolean asBoolean(String propertyName,
                                Object value)

asStringArray

public static String[] asStringArray(String propertyName,
                                     Object value)

Helper method to convert generic property value into array of Strings. Should be used when a property is expected to be String, String[] or Collection<String>

Parameters:

propertyName -

value -

Returns:

asStringArray

public static String[] asStringArray(String propertyName,
                                     Object value,
                                     boolean splitStrings)

Helper method to convert generic property value into array of Strings. A different variant of asStringArray(String, Object), which may be told to treat String values as comma-separated values.

Parameters:

propertyName -

value -

splitStrings -

Returns:

getPaxWebProperty

public static <T> T getPaxWebProperty(org.osgi.framework.ServiceReference<?> serviceReference,
                                      String legacyName,
                                      String whiteboardName,
                                      BiFunction<String,Object,T> propertyProvider)

Gets a service property by checking legacy and whiteboard property names, printing relevant warnings, if needed.

Type Parameters:

T -

Parameters:

serviceReference -

legacyName -

whiteboardName -

propertyProvider -

Returns:

getHighestRankedModel

public static OsgiContextModel getHighestRankedModel(Set<OsgiContextModel> rankedSet)

Gets first OsgiContextModel from ranked set or null if not available.

Parameters:

rankedSet -

Returns:

isBundleProtocol

public static boolean isBundleProtocol(URL url)

Checks whether given URL uses protocol used by Bundle.getResource(String) (at least for Felix and Equinox).

Parameters:

url -

getPaxWebJspBundle

public static org.osgi.framework.Bundle getPaxWebJspBundle(org.osgi.framework.BundleContext bundleContext)

getPaxWebJspBundle

public static org.osgi.framework.Bundle getPaxWebJspBundle(org.osgi.framework.Bundle bundle)

getJettyWebSocketBundle

public static org.osgi.framework.Bundle getJettyWebSocketBundle(org.osgi.framework.Bundle bundle)

Specialized method that's used to add Jetty WebSocket bundle that we know to contain required ServletContainerInitializer services. Actually Jetty has two bundles with SCIs (websocket-server and javax-websocket-server-impl), but the JSR356 one is wired to the native one

Parameters:

bundle -

Returns:

getTomcatWebSocketBundle

public static org.osgi.framework.Bundle getTomcatWebSocketBundle(org.osgi.framework.Bundle bundle)

Specialized method that's used to add Tomcat WebSocket bundle that we know to contain required ServletContainerInitializer services

Parameters:

bundle -

Returns:

getUndertowWebSocketBundle

public static org.osgi.framework.Bundle getUndertowWebSocketBundle(org.osgi.framework.Bundle bundle)

Specialized method that's used to add Undertow WebSocket bundle that we know to contain required ServletContainerInitializer services

Parameters:

bundle -

Returns:

getPaxWebUndertowWebSocketBundle

public static org.osgi.framework.Bundle getPaxWebUndertowWebSocketBundle(org.osgi.framework.Bundle bundle)

Specialized method that's used to add Undertow WebSocket bundle that we know to contain required ServletContainerInitializer services

Parameters:

bundle -

Returns:

getPaxWebWebSocketsBundle

public static org.osgi.framework.Bundle getPaxWebWebSocketsBundle(org.osgi.framework.Bundle bundle)

Find Pax Web bundle for generic (Whiteboard and HttpService) support for WebSockets

Parameters:

bundle -

Returns:

getManifestHeader

public static String getManifestHeader(org.osgi.framework.Bundle bundle,
                                       String key)

Returns a named header from a bundle or from one of its attached fragments

Parameters:

bundle -

key -

Returns:

isFragment

public static boolean isFragment(org.osgi.framework.Bundle bundle)

Checkes whether a Bundle is a fragment bundle.

Parameters:

bundle -

Returns:

isDirectory

public static boolean isDirectory(URL location)

Checks if given location is a directory

Parameters:

location -

Returns:

useSameContextPath

public static boolean useSameContextPath(ElementModel<?,?> model1,
                                         ElementModel<?,?> model2)

Returns true if two elements models use at least one OsgiContextModel referring to the same cotext path.

Parameters:

model1 -

model2 -

Returns:

isConfigurationAdminAvailable

public static boolean isConfigurationAdminAvailable(Class<?> cls)

isEventAdminAvailable

public static boolean isEventAdminAvailable(Class<?> cls)

Check if org.osgi.service.event.EventAdmin is available

Returns:

true if EventAdmin class can be loaded, false otherwhise

isJasyptAvailable

public static boolean isJasyptAvailable(Class<?> cls)

Check if Jasypt bundle is available

Returns: