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  			}
75  
76  			public static interface Metrics {
77  
78  			}
79  		}
80  		
81  		public interface Connector {
82  
83  			public final static String NAME = "Connector"; //$NON-NLS-1$
84  			public final static String DESCRIPTION = "A specification of a resource that can be used to access or store repository information"; //$NON-NLS-1$
85  			
86  			public static interface Operations {
87  				
88  				//Connector operations
89  				public final static String PING = "pingConnector"; //$NON-NLS-1$
90  				
91  				//Connection pool operations
92  				// public final static String FLUSH = "flush"; //$NON-NLS-1$
93  				
94  				public static interface Parameters {
95  					public final static String CONNECTOR_NAME = "connectorName"; //$NON-NLS-1$
96  				}
97  
98  			}
99  
100 			public static interface Metrics {
101 				public final static String INUSECONNECTIONS = "getInUseConnections"; //$NON-NLS-1$
102 			}
103 		}
104 
105 		public interface SequencingService {
106 
107 			public final static String NAME = "ModeShapeSequencingService"; //$NON-NLS-1$
108 			public final static String MODESHAPE_TYPE = "ModeShape"; //$NON-NLS-1$
109 			public final static String MODESHAPE_SUB_TYPE = "SequencingService"; //$NON-NLS-1$
110 			public final static String DISPLAY_NAME = "Sequencing Service"; //$NON-NLS-1$
111 			public final static String DESC = "A ModeShape sequencing service"; //$NON-NLS-1$
112 			
113 			public static interface Operations {
114 
115 			}
116 
117 			public static interface Metrics {
118 				public final static String NUM_NODES_SEQUENCED = "getNodesSequencedCount"; //$NON-NLS-1$
119 				public final static String NUM_NODES_SKIPPED = "getNodesSkippedCount"; //$NON-NLS-1$
120 			}
121 		}
122 		
123 		public interface SequencerConfig {
124 
125 			public final static String NAME = "Sequencer"; //$NON-NLS-1$
126 			public final static String DISPLAY_NAME = "Sequencer"; //$NON-NLS-1$
127 			public final static String DESC = "A ModeShape sequencer"; //$NON-NLS-1$
128 			
129 			public static interface Operations {
130 
131 			}
132 
133 			public static interface Metrics {
134 
135 			}
136 		}
137 	}
138 }