View Javadoc

1   /*
2    * ModeShape (http://www.modeshape.org)
3    * See the COPYRIGHT.txt file distributed with this work for information
4    * regarding copyright ownership.  Some portions may be licensed
5    * to Red Hat, Inc. under one or more contributor license agreements.
6    * See the AUTHORS.txt file in the distribution for a full listing of 
7    * individual contributors. 
8    *
9    * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10   * is licensed to you under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation; either version 2.1 of
12   * the License, or (at your option) any later version.
13   *
14   * ModeShape is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   * Lesser General Public License for more details.
18   *
19   * You should have received a copy of the GNU Lesser General Public
20   * License along with this software; if not, write to the Free
21   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23   */
24  package org.modeshape.rhq.plugin.util;
25  
26  /**
27   * These are properties required for connecting to the profile service and
28   * getting a handle to a specific component related to ModeShape.
29   * @since 2.1
30   */
31  public interface PluginConstants {
32  
33  	/**
34  	 * Log4j log category to use
35  	 */
36  	public final static String DEFAULT_LOGGER_CATEGORY = "org.modeshape"; //$NON-NLS-1$
37  
38  	/**
39  	 * Use these component type names when calling Connection related methods
40  	 * that require the type.
41  	 * 
42  	 * @since 1.0
43  	 */
44  	public interface ComponentType {
45  
46  		public interface Engine {
47  
48  			public final static String NAME = "Engine"; //$NON-NLS-1$
49  			public final static String MODESHAPE_TYPE = "ModeShape"; //$NON-NLS-1$
50  			public final static String MODESHAPE_SUB_TYPE = "Engine"; //$NON-NLS-1$
51  			public final static String MODESHAPE_ENGINE = "ModeShapeEngine"; //$NON-NLS-1$
52  			public final static String MODESHAPE_DISPLAYNAME = "ModeShape"; //$NON-NLS-1$
53  			public final static String MODESHAPE_ENGINE_DESC = "A ModeShape Engine instance"; //$NON-NLS-1$
54  			
55  
56  			public static interface Operations {
57  				public final static String SHUTDOWN = "shutdown"; //$NON-NLS-1$
58  				public final static String RESTART = "restart"; //$NON-NLS-1$
59  				
60  			}
61  
62  			public static interface Metrics {
63  
64  			}
65  		}
66  		
67  		public interface Repository {
68  
69  			public final static String NAME = "Repository"; //$NON-NLS-1$
70  			public final static String MODESHAPE_REPOSITORY_DESC = "An information store with hierarchical organization, versioning, events, search, query, and automated content extraction"; //$NON-NLS-1$
71  
72  			public static interface Operations {
73  				
74  				public static interface Parameters {
75  					public final static String REPOSITORY_NAME = "repositoryName"; //$NON-NLS-1$
76  				}
77  			}
78  	
79  			public static interface Metrics {
80  				public final static String ACTIVESESSIONS = "getActiveSessions"; //$NON-NLS-1$
81  			}
82  		}
83  		
84  		public interface Connector {
85  
86  			public final static String NAME = "Connector"; //$NON-NLS-1$
87  			public final static String DESCRIPTION = "A specification of a resource that can be used to access or store repository information"; //$NON-NLS-1$
88  			
89  			public static interface Operations {
90  				
91  				//Connector operations
92  				public final static String PING = "pingConnector"; //$NON-NLS-1$
93  				
94  				//Connection pool operations
95  				// public final static String FLUSH = "flush"; //$NON-NLS-1$
96  				
97  				public static interface Parameters {
98  					public final static String CONNECTOR_NAME = "connectorName"; //$NON-NLS-1$
99  				}
100 			}
101 
102 			public static interface Metrics {
103 				public final static String INUSECONNECTIONS = "getInUseConnections"; //$NON-NLS-1$
104 			}
105 		}
106 
107 		public interface SequencingService {
108 
109 			public final static String NAME = "ModeShapeSequencingService"; //$NON-NLS-1$
110 			public final static String MODESHAPE_TYPE = "ModeShape"; //$NON-NLS-1$
111 			public final static String MODESHAPE_SUB_TYPE = "SequencingService"; //$NON-NLS-1$
112 			public final static String DISPLAY_NAME = "Sequencing Service"; //$NON-NLS-1$
113 			public final static String DESC = "A ModeShape sequencing service"; //$NON-NLS-1$
114 			
115 			public static interface Operations {
116 
117 			}
118 
119 			public static interface Metrics {
120 				public final static String NUM_NODES_SEQUENCED = "getNodesSequencedCount"; //$NON-NLS-1$
121 				public final static String NUM_NODES_SKIPPED = "getNodesSkippedCount"; //$NON-NLS-1$
122 			}
123 		}
124 		
125 		public interface SequencerConfig {
126 
127 			public final static String NAME = "Sequencer"; //$NON-NLS-1$
128 			public final static String DISPLAY_NAME = "Sequencer"; //$NON-NLS-1$
129 			public final static String DESC = "A ModeShape sequencer"; //$NON-NLS-1$
130 			
131 			public static interface Operations {
132 
133 			}
134 
135 			public static interface Metrics {
136 
137 			}
138 		}
139 	}
140 }