| Home >> All >> org >> eclipse >> osgi |
| • | org.eclipse.osgi.framework.* (117) | • | org.eclipse.osgi.internal.* (24) | • | org.eclipse.osgi.service.* (27) |
| • | org.eclipse.osgi.util.* (1) |
Package Samples:
• org.eclipse.osgi.framework.internal.core
• org.eclipse.osgi.framework.internal.reliablefile
• org.eclipse.osgi.framework.internal.protocol.reference
• org.eclipse.osgi.framework.internal.protocol.bundleentry
• org.eclipse.osgi.framework.internal.protocol.bundleresource
• org.eclipse.osgi.framework.internal.defaultadaptor
• org.eclipse.osgi.framework.adaptor.core
• org.eclipse.osgi.internal.resolver
• org.eclipse.osgi.service.resolver
• org.eclipse.osgi.service.systembundle
• org.eclipse.osgi.service.debug
• org.eclipse.osgi.framework.msg
• org.eclipse.osgi.framework.launcher
• org.eclipse.osgi.framework.internal.protocol
• org.eclipse.osgi.framework.eventmgr
• org.eclipse.osgi.framework.debug
• org.eclipse.osgi.framework.console
• org.eclipse.osgi.framework.util
• org.eclipse.osgi.framework.log
• org.eclipse.osgi.framework.adaptor
Classes:
• FilterImpl: RFC 1960-based Filter. Filter objects can be created by calling the constructor with the desired filter string. A Filter object can be called numerous times to determine if the match argument matches the filter string that was used to create the Filter object. The syntax of a filter string is the string representation of LDAP search filters as defined in RFC 1960: A String Representation of LDAP Search Filters (available at http://www.ietf.org/rfc/rfc1960.txt). It should be noted that RFC 2254: A String Representation of LDAP Search Filters (available at http://www.ietf.org/rfc/rfc2254.txt) supersedes ...
• EventManager: This class is the central class for the Event Manager. Each program that wishes to use the Event Manager should construct an EventManager object and use that object to construct ListenerQueue for dispatching events. EventListeners objects should be used to manage listener lists. This example uses the ficticous SomeEvent class and shows how to use this package to deliver a SomeEvent to a set of SomeEventListeners. // Create an EventManager with a name for an asynchronous event dispatch thread EventManager eventManager = new EventManager("SomeEvent Async Event Dispatcher Thread"); // Create an EventListeners ...
• BundleNativeCode: This class represents a description of native code. Native Code dependencies The Bundle-NativeCode header allows a bundle to carry the native code it needs, and make use of it when it is installed. The bundle must have RuntimePermission in order to run native code in the Framework. The value of the header must conform to the following syntax: Bundle-NativeCode: nativecode-clause ( , nativecode-clause)* nativecode-clause: nativepaths ( ; env-parameter )* nativepaths: nativepath ( ; nativepath )* env-parameter: ( processordef | osnamedef | osversiondef | languagedef ) processordef: processor= token ...
• Launcher: This class provides an entry point for launching the OSGi framework. It configures the OSGi framework according to the command line arguments: -con[sole][: port ] Starts the OSGi framework with a console window. Any command line arguments not recognized are passed to the console for it to execute. If a port is specified the console will listen on that port for commands. If no port is specified, the console will use System.in and System.out. -adaptor[:adaptor-name][adaptor-args] [adaptor-name] := "" | fully qualified class name of the FrameworkAdapter [adaptor-args] := *( ":" [value]) [value] := ...
• FrameworkCommandProvider: This class provides methods to execute commands from the command line. It registers itself as a CommandProvider so it can be invoked by a CommandInterpreter. The FrameworkCommandProvider registers itself with the highest ranking (Integer.MAXVALUE) so it will always be called first. Other CommandProviders should register with lower rankings. The commands provided by this class are: ---Controlling the OSGi framework--- close - shutdown and exit exit - exit immediately (System.exit) gc - perform a garbage collection init - uninstall all bundles launch - start the Service Management Framework setprop ...
• PermissionAdminImpl: Permission Admin service for the OSGi specification. The Permission Admin service allows operators to manage the permissions of bundles. There is at most one Permission Admin service present in the Framework. Access to the Permission Admin service is protected by corresponding ServicePermission . In addition the AdminPermission is required to actually set permissions. Bundle permissions are managed using a permission table. A bundle's location serves as the key into this permission table. The value of a table entry is the set of permissions (of type PermissionInfo ) granted to the bundle with the ...
• ListenerQueue: The ListenerQueue is used to snapshot the set of listeners at the time the event is fired. The snapshot list is then used to dispatch events to those listeners. A ListenerQueue object is associated with a specific EventManager object. ListenerQueue objects constructed with the same EventManager object will get in-order delivery of events using asynchronous delivery. No delivery order is guaranteed for synchronous delivery to avoid any potential deadly embraces. ListenerQueue objects are created as necesssary to build a set of listeners that should receive a specific event or events. Once the set ...
• Version: Version identifier for a plug-in. In its string representation, it consists of up to 4 tokens separated by a decimal point. The first 3 tokens are positive integer numbers, the last token is an uninterpreted string (no whitespace characters allowed). For example, the following are valid version identifiers (as strings): 0.0.0 1.0.127564 3.7.2.build-127J 1.9 (interpreted as 1.9.0 ) 3 (interpreted as 3.0.0 ) The version identifier can be decomposed into a major, minor, micro level component and qualifier components. A difference in the major component is interpreted as an incompatible version change. ...
• ManifestElement: This class represents a single manifest element. A manifest element must consist of a single String value. The String value may be split up into component values each separated by a ';'. A manifeset element may optionally have a set of attribute values associated with it. The general syntax of a manifest element is the following ManifestElement ::= headervalues (';' attribute)* headervalues ::= headervalue (';' headervalue)* headervalue ::= attribute ::= key '=' value key ::= token value ::= token | quoted-string For example, The following is an example of a manifest element to the Export-Package ...
• PackageAdminImpl: PackageAdmin service for the OSGi specification. Framework service which allows bundle programmers to inspect the packages exported in the framework and eagerly update or uninstall bundles. If present, there will only be a single instance of this service registered in the framework. The term exported package (and the corresponding interface org.osgi.service.packageadmin.ExportedPackage ) refers to a package that has actually been exported (as opposed to one that is available for export). Note that the information about exported packages returned by this service is valid only until the next time ...
• FileManager: File managers provide a facility for tracking the state of files being used and updated by several systems at the same time. The typical usecase is in shared configuration data areas. The general principle is to maintain a table which maps user-level file name onto actual disk file. The filename is actually never used, and the file is always stored under the given filename suffixed by an integer. If a file needs to be modified, it is written into a new file whose name suffix is incremented. Once the instance has been created, open() must be called before performing any other operation. On open ...
• ServiceReferenceImpl: A reference to a service. The framework returns ServiceReference objects from the BundleContext.getServiceReference 55 and BundleContext.getServiceReferences 55 methods. A ServiceReference may be shared between bundles and can be used to examine the properties of the service and to get the service object (See BundleContext.getService 55 ). A registered service may have multiple, distinct ServiceReference objects which refer to it. However these ServiceReference objects will have the same hashCode and the equals method will return true when compared.
• BundleOperation: Bundle Storage interface for managing a persistent storage life cycle operation upon a bundle. This class is used to provide methods to manage a life cycle operation on a bundle in persistent storage. BundleOperation objects are returned by the FrameworkAdaptor object and are called by OSGi to complete the persistent storage life cycle operation. For example Bundle bundle; BundleOperation storage = adaptor.installBundle(location, source); try { bundle = storage.begin(); // Perform some implementation specific work // which may fail. storage.commit(false); // bundle has been successfully installed ...
• DefaultAdaptor: The DefaultAdaptor for the Framework. This adaptor uses root bundle store directory on the local filesystem to store bundle files and bundle data. Each bundle installed in the Framework will have a unique directory using the bundle ID as the name. Each bundles unique directory has a generational directory a data directory and a metadata file. The generational directory is used to store the different versions of the bundle that have been installed. Each time the bundle is updated a new generational directory will be created. The data directory is used to create data file objects requested by the ...
• CommandProvider: When an object wants to provide a number of commands to the console, it should register an object with this interface. Some console can then pick this up and execute command lines. The SERVICE_RANKING registration property can be used to influence the order that a CommandProvider gets called. Specify a value less than Integer.MAXVALUE, where higher is more significant. The default value if SERVICE_RANKING is not set is 0. The interface contains only methods for the help. The console should use inspection to find the commands. All public commands, starting with a '_' and taking a CommandInterpreter ...
• ServiceRegistrationImpl: A registered service. The framework returns a ServiceRegistration object when a BundleContext.registerService 55 method is successful. This object is for the private use of the registering bundle and should not be shared with other bundles. The ServiceRegistration object may be used to update the properties for the service or to unregister the service. If the ServiceRegistration is garbage collected the framework may remove the service. This implies that if a bundle wants to keep its service registered, it should keep the ServiceRegistration object referenced.
• PermissionStorage: Permission Storage interface for managing a persistent storage of bundle permissions. This class is used to provide methods to manage persistent storage of bundle permissions. The PermissionStorage object is returned by the FrameworkAdaptor object and is called to persistently store bundle permissions. The permission data will typically take the form of encoded PermissionInfo Strings. See org.osgi.service.permissionadmin.PermissionInfo. For example PermissionStorage storage = adaptor.getPermissionStorage(); try { storage.setPermissionData(location, permissions); } catch (IOException e) { // Take ...
• FrameworkAdaptor: FrameworkAdaptor interface to the osgi framework. This class is used to provide platform specific support for the osgi framework. The OSGi framework will call this class to perform platform specific functions. Classes that implement FrameworkAdaptor MUST provide a constructor that takes as a parameter an array of Strings. This array will contain arguments to be handled by the FrameworkAdaptor. The FrameworkAdaptor implementation may define the format and content of its arguments. The constructor should parse the arguments passed to it and remember them. The initialize method should perform the ...
• URLStreamHandlerProxy: The URLStreamHandlerProxy is a URLStreamHandler that acts as a proxy for registered URLStreamHandlerServices. When a URLStreamHandler is requested from the URLStreamHandlerFactory and it exists in the service registry, a URLStreamHandlerProxy is created which will pass all the requests from the requestor to the real URLStreamHandlerService. We can't return the real URLStreamHandlerService from the URLStreamHandlerFactory because the JVM caches URLStreamHandlers and therefore would not support a dynamic environment of URLStreamHandlerServices being registered and unregistered.
• Msg: This class retrieves strings from a resource bundle and returns them, formatting them with MessageFormat when required. It is used by the system classes to provide national language support, by looking up messages in the org.eclipse.osgi.framework.internal.core.ExternalMessages resource bundle. Note that if this file is not available, or an invalid key is looked up, or resource bundle support is not available, the key itself will be returned as the associated message. This means that the KEY should a reasonable human-readable (english) string.
• ConsoleMsg: This class retrieves strings from a resource bundle and returns them, formatting them with MessageFormat when required. It is used by the system classes to provide national language support, by looking up messages in the org.eclipse.osgi.framework.internal.core.ConsoleMessages resource bundle. Note that if this file is not available, or an invalid key is looked up, or resource bundle support is not available, the key itself will be returned as the associated message. This means that the KEY should a reasonable human-readable (english) string.
• Handler: URLStreamHandler for reference protocol. A reference URL is used to hold a reference to a local file URL. A reference URL allows bundles to be installed by reference. This means the content of the bundle will not be copied. Instead the content of the bundle will be loaded from the reference location specified by the reference URL. The Framework only supports reference URLs that refer to a local file URL. For example: reference:file:/eclipse/plugins/org.eclipse.myplugin_1.0.0/ reference:file:/eclispe/plugins/org.eclipse.mybundle_1.0.0.jar
• StateMsg: This class retrieves strings from a resource bundle and returns them, formatting them with MessageFormat when required. It is used by the system classes to provide national language support, by looking up messages in the org.eclipse.osgi.internal.resolver.StateMessages resource bundle. Note that if this file is not available, or an invalid key is looked up, or resource bundle support is not available, the key itself will be returned as the associated message. This means that the KEY should a reasonable human-readable (english) string.
• PermissionsHash: A simple Hashtable based collection of Permission objects. The class' .implies method simply scans each permission individually and asks if the permission should be granted. No addition semantics is provided by the collection, so it is not possible to grant permissions whose "grantedness" is split across multiple stored Permissions. Instances of this class can be used to store heterogeneous collections of permissions, as long as it is not necessary to remember when multiple occurances of .equal permissions are added.
• ContentHandlerProxy: The ContentHandlerProxy is a ContentHandler that acts as a proxy for registered ContentHandlers. When a ContentHandler is requested from the ContentHandlerFactory and it exists in the service registry, a ContentHandlerProxy is created which will pass all the requests from the requestor to the real ContentHandler. We can't return the real ContentHandler from the ContentHandlerFactory because the JVM caches ContentHandlers and therefore would not support a dynamic environment of ContentHandlers being registered and unregistered.
| Home | Contact Us | Privacy Policy | Terms of Service |