[jboss-cvs] JBossAS SVN: r87003 - projects/jboss-man/trunk/managed/src/main/java/org/jboss/managed/api.

[jboss-cvs-commits at lists.jboss.org]

Author: scott.stark at jboss.org
Date: 2009-04-08 17:43:57 -0400 (Wed, 08 Apr 2009)
New Revision: 87003

Added:
   projects/jboss-man/trunk/managed/src/main/java/org/jboss/managed/api/TransientAttachments.java
Log:
JBMAN-75, Support for transient attachments on operations, parameters

Added: projects/jboss-man/trunk/managed/src/main/java/org/jboss/managed/api/TransientAttachments.java
===================================================================
--- projects/jboss-man/trunk/managed/src/main/java/org/jboss/managed/api/TransientAttachments.java	                        (rev 0)
+++ projects/jboss-man/trunk/managed/src/main/java/org/jboss/managed/api/TransientAttachments.java	2009-04-08 21:43:57 UTC (rev 87003)
@@ -0,0 +1,65 @@
+/*
+ * JBoss, Home of Professional Open Source
+ * Copyright 2009, Red Hat Middleware LLC, and individual contributors
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package org.jboss.managed.api;
+
+/**
+ * A common interface for managed elements that support transient attachments
+ * 
+ * @author Scott.Stark at jboss.org
+ * @version $Revision$
+ */
+public interface TransientAttachments
+{
+   /**
+    * Get a transient attachment from the parameter.
+    * 
+    * @see #setTransientAttachment(String, Object)
+    * 
+    * @param name the name
+    * @return the attachment
+    */
+   Object getTransientAttachment(String name);
+   
+   /**
+    * Get an attachment from the parameter,
+    * uses the expected type as both the name
+    * and to cast the resulting object.
+    * 
+    * @param <T> the expected type
+    * @param expectedType the expected type
+    * @return the attachment
+    * @throws ClassCastException when the object is not of the expected type
+    */
+   <T> T getTransientAttachment(Class<T> expectedType);
+
+   /**
+    * Set an transient attachment against the parameter. A transient attachment
+    * is one that will not be available to clients of the parameter, typically
+    * admin tools. Such attachments are used by the server side where the
+    * underlying metadata to which the parameter is associated is available.
+    * 
+    * @param name the name
+    * @param attachment the attachment, pass null to remove an attachment
+    * @throws IllegalArgumentException for a null name
+    */
+   void setTransientAttachment(String name, Object attachment);
+}


Property changes on: projects/jboss-man/trunk/managed/src/main/java/org/jboss/managed/api/TransientAttachments.java
___________________________________________________________________
Name: svn:keywords
   + Id Revision