Return-Path: X-Original-To: apmail-felix-commits-archive@www.apache.org Delivered-To: apmail-felix-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 9763310A65 for ; Mon, 1 Jul 2013 12:58:21 +0000 (UTC) Received: (qmail 18414 invoked by uid 500); 1 Jul 2013 12:58:19 -0000 Delivered-To: apmail-felix-commits-archive@felix.apache.org Received: (qmail 18330 invoked by uid 500); 1 Jul 2013 12:58:19 -0000 Mailing-List: contact commits-help@felix.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@felix.apache.org Delivered-To: mailing list commits@felix.apache.org Received: (qmail 18088 invoked by uid 99); 1 Jul 2013 12:58:16 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 01 Jul 2013 12:58:16 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 01 Jul 2013 12:57:43 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id AEB532388C54; Mon, 1 Jul 2013 12:56:26 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1498419 [23/35] - in /felix/site/trunk/content/apidocs: ./ configadmin/ configadmin/1.0.0/ configadmin/1.0.0/org/ configadmin/1.0.0/org/apache/ configadmin/1.0.0/org/apache/felix/ configadmin/1.0.0/org/apache/felix/cm/ configadmin/1.0.0/or... Date: Mon, 01 Jul 2013 12:56:13 -0000 To: commits@felix.apache.org From: fmeschbe@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20130701125626.AEB532388C54@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationEvent.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationEvent.html?rev=1498419&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationEvent.html (added) +++ felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationEvent.html Mon Jul 1 12:56:06 2013 @@ -0,0 +1,446 @@ + + + + + + +ConfigurationEvent (Apache Felix Configuration Admin Service 1.2.4 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.osgi.service.cm
+

Class ConfigurationEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class ConfigurationEvent
+extends Object
    +
    A Configuration Event. + +

    + ConfigurationEvent objects are delivered to all registered + ConfigurationListener service objects. ConfigurationEvents + must be asynchronously delivered in chronological order with respect to each + listener. + +

    + A type code is used to identify the type of event. The following event types + are defined: +

    + Additional event types may be defined in the future. + +

    + Security Considerations. ConfigurationEvent objects do not + provide Configuration objects, so no sensitive configuration + information is available from the event. If the listener wants to locate the + Configuration object for the specified pid, it must use + ConfigurationAdmin.

    +
    Since:
    +
    1.2
    +
    Version:
    +
    $Revision: 809193 $
    +
    See Also:
    ConfigurationListener
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static intCM_DELETED +
      A Configuration has been deleted.
      +
      static intCM_UPDATED +
      A Configuration has been updated.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ConfigurationEvent(org.osgi.framework.ServiceReference reference, + int type, + String factoryPid, + String pid) +
      Constructs a ConfigurationEvent object from the given + ServiceReference object, event type, and pids.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        CM_UPDATED

        +
        public static final int CM_UPDATED
        +
        A Configuration has been updated. + +

        + This ConfigurationEvent type that indicates that a + Configuration object has been updated with new properties. + + An event is fired when a call to Configuration.update(Dictionary) + successfully changes a configuration. + +

        + The value of CM_UPDATED is 1.

        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        CM_DELETED

        +
        public static final int CM_DELETED
        +
        A Configuration has been deleted. + +

        + This ConfigurationEvent type that indicates that a + Configuration object has been deleted. + + An event is fired when a call to Configuration.delete() + successfully deletes a configuration. + +

        + The value of CM_DELETED is 2.

        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConfigurationEvent

        +
        public ConfigurationEvent(org.osgi.framework.ServiceReference reference,
+                  int type,
+                  String factoryPid,
+                  String pid)
        +
        Constructs a ConfigurationEvent object from the given + ServiceReference object, event type, and pids.
        +
        Parameters:
        reference - The ServiceReference object of the + Configuration Admin service that created this event.
        type - The event type. See getType().
        factoryPid - The factory pid of the associated configuration if the + target of the configuration is a ManagedServiceFactory. Otherwise + null if the target of the configuration is a + ManagedService.
        pid - The pid of the associated configuration.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFactoryPid

        +
        public String getFactoryPid()
        +
        Returns the factory pid of the associated configuration.
        +
        Returns:
        Returns the factory pid of the associated configuration if the + target of the configuration is a ManagedServiceFactory. Otherwise + null if the target of the configuration is a + ManagedService.
        +
        • +
      + + + +
        +
      • +

        getPid

        +
        public String getPid()
        +
        Returns the pid of the associated configuration.
        +
        Returns:
        Returns the pid of the associated configuration.
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public int getType()
        +
        Return the type of this event. +

        + The type values are: +

        +
        Returns:
        The type of this event.
        +
        • +
      + + + +
        +
      • +

        getReference

        +
        public org.osgi.framework.ServiceReference getReference()
        +
        Return the ServiceReference object of the Configuration + Admin service that created this event.
        +
        Returns:
        The ServiceReference object for the Configuration + Admin service that created this event.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2006–2013 The Apache Software Foundation. All rights reserved.

+ + Added: felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationException.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationException.html?rev=1498419&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationException.html (added) +++ felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationException.html Mon Jul 1 12:56:06 2013 @@ -0,0 +1,386 @@ + + + + + + +ConfigurationException (Apache Felix Configuration Admin Service 1.2.4 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.osgi.service.cm
+

Class ConfigurationException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    +
    public class ConfigurationException
+extends Exception
    +
    An Exception class to inform the Configuration Admin service + of problems with configuration data.
    +
    Version:
    +
    $Revision: 809193 $
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConfigurationException

        +
        public ConfigurationException(String property,
+                      String reason)
        +
        Create a ConfigurationException object.
        +
        Parameters:
        property - name of the property that caused the problem, + null if no specific property was the cause
        reason - reason for failure
        +
        • +
      + + + +
        +
      • +

        ConfigurationException

        +
        public ConfigurationException(String property,
+                      String reason,
+                      Throwable cause)
        +
        Create a ConfigurationException object.
        +
        Parameters:
        property - name of the property that caused the problem, + null if no specific property was the cause
        reason - reason for failure
        cause - The cause of this exception.
        Since:
        +
        1.2
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getProperty

        +
        public String getProperty()
        +
        Return the property name that caused the failure or null.
        +
        Returns:
        name of property or null if no specific property caused the + problem
        +
        • +
      + + + +
        +
      • +

        getReason

        +
        public String getReason()
        +
        Return the reason for this exception.
        +
        Returns:
        reason of the failure
        +
        • +
      + + + +
        +
      • +

        getCause

        +
        public Throwable getCause()
        +
        Returns the cause of this exception or null if no cause was + set.
        +
        +
        Overrides:
        +
        getCause in class Throwable
        +
        Returns:
        The cause of this exception or null if no cause was + set.
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        initCause

        +
        public Throwable initCause(Throwable cause)
        +
        Initializes the cause of this exception to the specified value.
        +
        +
        Overrides:
        +
        initCause in class Throwable
        +
        Parameters:
        cause - The cause of this exception.
        +
        Returns:
        This exception.
        +
        Throws:
        +
        IllegalArgumentException - If the specified cause is this + exception.
        +
        IllegalStateException - If the cause of this exception has already + been set.
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006–2013 The Apache Software Foundation. All rights reserved.

+ + Added: felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationListener.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationListener.html?rev=1498419&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationListener.html (added) +++ felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationListener.html Mon Jul 1 12:56:06 2013 @@ -0,0 +1,234 @@ + + + + + + +ConfigurationListener (Apache Felix Configuration Admin Service 1.2.4 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.osgi.service.cm
+

Interface ConfigurationListener

+
+
+
+
    +
  • +
    +
    +
    public interface ConfigurationListener
    +
    Listener for Configuration Events. When a ConfigurationEvent + is fired, it is asynchronously delivered to a + ConfigurationListener. + +

    + ConfigurationListener objects are registered with the + Framework service registry and are notified with a + ConfigurationEvent object when an event is fired. +

    + ConfigurationListener objects can inspect the received + ConfigurationEvent object to determine its type, the pid of + the Configuration object with which it is associated, and the + Configuration Admin service that fired the event. + +

    + Security Considerations. Bundles wishing to monitor configuration events will + require ServicePermission[ConfigurationListener,REGISTER] to + register a ConfigurationListener service.

    +
    Since:
    +
    1.2
    +
    Version:
    +
    $Revision: 809193 $
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidconfigurationEvent(ConfigurationEvent event) +
      Receives notification of a Configuration that has changed.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        configurationEvent

        +
        void configurationEvent(ConfigurationEvent event)
        +
        Receives notification of a Configuration that has changed.
        +
        Parameters:
        event - The ConfigurationEvent.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006–2013 The Apache Software Foundation. All rights reserved.

+ + Added: felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationPermission.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationPermission.html?rev=1498419&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationPermission.html (added) +++ felix/site/trunk/content/apidocs/configadmin/1.2.4/org/osgi/service/cm/ConfigurationPermission.html Mon Jul 1 12:56:06 2013 @@ -0,0 +1,440 @@ + + + + + + +ConfigurationPermission (Apache Felix Configuration Admin Service 1.2.4 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.osgi.service.cm
+

Class ConfigurationPermission

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable, Guard
    +
    +
    +
    +
    public final class ConfigurationPermission
+extends BasicPermission
    +
    Indicates a bundle's authority to configure bundles. + + This permission has only a single action: CONFIGURE.
    +
    Since:
    +
    1.2
    +
    Version:
    +
    $Revision: 809193 $
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConfigurationPermission

        +
        public ConfigurationPermission(String name,
+                       String actions)
        +
        Create a new ConfigurationPermission.
        +
        Parameters:
        name - Name must be "*".
        actions - configure (canonical order).
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        implies

        +
        public boolean implies(Permission p)
        +
        Determines if a ConfigurationPermission object "implies" + the specified permission.
        +
        +
        Overrides:
        +
        implies in class BasicPermission
        +
        Parameters:
        p - The target permission to check.
        +
        Returns:
        true if the specified permission is implied by + this object; false otherwise.
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(Object obj)
        +
        Determines the equality of two ConfigurationPermission + objects. +

        + Two ConfigurationPermission objects are equal.

        +
        +
        Overrides:
        +
        equals in class BasicPermission
        +
        Parameters:
        obj - The object being compared for equality with this object.
        +
        Returns:
        true if obj is equivalent to this + ConfigurationPermission; false + otherwise.
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        Returns the hash code value for this object.
        +
        +
        Overrides:
        +
        hashCode in class BasicPermission
        +
        Returns:
        Hash code value for this object.
        +
        • +
      + + + +
        +
      • +

        getActions

        +
        public String getActions()
        +
        Returns the canonical string representation of the + ConfigurationPermission actions. + +

        + Always returns present ConfigurationPermission actions in + the following order: CONFIGURE

        +
        +
        Overrides:
        +
        getActions in class BasicPermission
        +
        Returns:
        Canonical string representation of the + ConfigurationPermission actions.
        +
        • +
      + + + +
        +
      • +

        newPermissionCollection

        +
        public PermissionCollection newPermissionCollection()
        +
        Returns a new PermissionCollection object suitable for + storing ConfigurationPermissions.
        +
        +
        Overrides:
        +
        newPermissionCollection in class BasicPermission
        +
        Returns:
        A new PermissionCollection object.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2006–2013 The Apache Software Foundation. All rights reserved.

+ +