forked from payara/Payara
/
ConnectorSniffer.java
221 lines (197 loc) · 7.65 KB
/
ConnectorSniffer.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// Portions Copyright [2019] Payara Foundation and/or affiliates
package com.sun.enterprise.connectors.connector.module;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.internal.deployment.GenericSniffer;
import com.sun.enterprise.module.HK2Module;
import com.sun.appserv.connectors.internal.api.ConnectorConstants;
import org.glassfish.api.container.Sniffer;
import org.glassfish.api.deployment.DeploymentContext;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.api.deployment.archive.ArchiveType;
import org.glassfish.deployment.common.DeploymentUtils;
import org.jvnet.hk2.annotations.Service;
import javax.inject.Singleton;
import java.io.IOException;
import java.util.logging.Logger;
import java.util.logging.Level;
import java.util.List;
import java.util.ArrayList;
import java.lang.annotation.Annotation;
import javax.inject.Inject;
/**
* Sniffer for detecting resource-adapter modules
*
* @author Jagadish Ramu
*/
@Service(name = ConnectorConstants.CONNECTOR_MODULE)
@Singleton
public class ConnectorSniffer extends GenericSniffer {
@Inject
private Logger logger;
@Inject RarType rarType;
@Inject ServiceLocator locator;
private static final Class[] connectorAnnotations = new Class[] {
javax.resource.spi.Connector.class };
public ConnectorSniffer() {
super(ConnectorConstants.CONNECTOR_MODULE, "META-INF/ra.xml", null);
}
final String[] containerNames = {"com.sun.enterprise.connectors.module.ConnectorContainer"};
/**
* Sets up the container libraries so that any imported bundle from the
* connector jar file will now be known to the module subsystem
*
* @param containerHome is where the container implementation resides
* @param logger the logger to use
* @throws java.io.IOException exception if something goes sour
*/
@Override
public HK2Module[] setup(String containerHome, Logger logger) throws IOException {
// do nothing, we are embedded in GFv3 for now
return null;
}
/**
* Returns the list of Containers that this Sniffer enables.
* <p/>
* The runtime will look up each container implementing
* using the names provided in the habitat.
*
* @return list of container names known to the habitat for this sniffer
*/
public String[] getContainersNames() {
return containerNames;
}
/**
* Returns the Module type
*
* @return the container name
*/
public String getModuleType() {
return ConnectorConstants.CONNECTOR_MODULE;
}
/**
* Returns the list of annotations types that this sniffer is interested in.
* If an application bundle contains at least one class annotated with
* one of the returned annotations, the deployment process will not
* call the handles method but will invoke the containers deployers as if
* the handles method had been called and returned true.
*
* @return list of annotations this sniffer is interested in or an empty array
*/
@Override
public Class<? extends Annotation>[] getAnnotationTypes() {
return connectorAnnotations;
}
/**
* @return whether this sniffer should be visible to user
*
*/
public boolean isUserVisible() {
return true;
}
/**
* @return whether this sniffer represents a Java EE container type
*
*/
public boolean isJavaEE() {
return true;
}
/**
* @return the set of the sniffers that should not co-exist for the
* same module. For example, ejb and appclient sniffers should not
* be returned in the sniffer list for a certain module.
* This method will be used to validate and filter the retrieved sniffer
* lists for a certain module
*
*/
public String[] getIncompatibleSnifferTypes() {
return new String[] {"ejb", "web"};
}
/**
* Returns true if the passed file or directory is recognized by this
* sniffer.
* @param context deployment context
* @return true if the location is recognized by this sniffer
*/
@Override
public boolean handles(DeploymentContext context) {
ArchiveType archiveType = habitat.getService(ArchiveType.class, context.getArchiveHandler().getArchiveType());
if (archiveType != null && !supportsArchiveType(archiveType)) {
return false;
}
return DeploymentUtils.isArchiveOfType(context.getSource(), rarType, context, locator);
}
/**
*
* This API is used to help determine if the sniffer should recognize
* the current archive.
* If the sniffer does not support the archive type associated with
* the current deployment, the sniffer should not recognize the archive.
*
* @param archiveType the archive type to check
* @return whether the sniffer supports the archive type
*
*/
public boolean supportsArchiveType(ArchiveType archiveType) {
if (archiveType.equals(rarType)) {
return true;
}
return false;
}
private static final List<String> deploymentConfigurationPaths =
initDeploymentConfigurationPaths();
private static List<String> initDeploymentConfigurationPaths() {
final List<String> result = new ArrayList<String>();
result.add("META-INF/ra.xml");
result.add("META-INF/sun-ra.xml");
result.add("META-INF/weblogic-ra.xml");
return result;
}
/**
* Returns the descriptor paths that might exist in a connector app.
*
* @return list of the deployment descriptor paths
*/
@Override
protected List<String> getDeploymentConfigurationPaths() {
return deploymentConfigurationPaths;
}
}