com.sun.enterprise.resource.deployer.MailSessionDeployer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2013 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 [2017-2021] Payara Foundation and/or affiliates
*/
// Portions Copyright [2017-2021] [Payara Foundation and/or its affiliates]
package com.sun.enterprise.resource.deployer;
import com.sun.appserv.connectors.internal.api.ConnectorConstants;
import com.sun.appserv.connectors.internal.api.ConnectorsUtil;
import com.sun.enterprise.config.serverbeans.Application;
import com.sun.enterprise.config.serverbeans.Resource;
import com.sun.enterprise.config.serverbeans.Resources;
import com.sun.enterprise.connectors.ConnectorRuntime;
import com.sun.enterprise.deployment.*;
import com.sun.logging.LogDomains;
import org.glassfish.deployment.common.Descriptor;
import org.glassfish.deployment.common.JavaEEResourceType;
import org.glassfish.deployment.common.RootDeploymentDescriptor;
import org.glassfish.javaee.services.CommonResourceProxy;
import org.glassfish.resourcebase.resources.api.ResourceInfo;
import org.glassfish.resources.javamail.config.MailResource;
import org.glassfish.resourcebase.resources.api.ResourceConflictException;
import org.glassfish.resourcebase.resources.api.ResourceDeployer;
import org.glassfish.resourcebase.resources.api.ResourceDeployerInfo;
import org.jvnet.hk2.annotations.Service;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.TransactionFailure;
import org.jvnet.hk2.config.types.Property;
import jakarta.inject.Inject;
import jakarta.inject.Provider;
import javax.naming.NamingException;
import java.beans.PropertyVetoException;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.glassfish.config.support.TranslatedConfigView;
/**
* Handle deployment of resources defined by @MailSessionDefinition
* and represented by a MailSessionDescriptor.
*/
@Service
@ResourceDeployerInfo(MailSessionDescriptor.class)
public class MailSessionDeployer implements ResourceDeployer {
@Inject
private Provider resourceManagerFactoryProvider;
@Inject
private Provider mailSessionProxyProvider;
@Inject
private Provider resourceNamingServiceProvider;
@Inject
private ConnectorRuntime runtime;
private static Logger _logger = LogDomains.getLogger(MailSessionDeployer.class, LogDomains.RSR_LOGGER);
@Override
public void deployResource(Object resource, String applicationName, String moduleName) throws Exception {
//do nothing
}
@Override
public void deployResource(Object resource) throws Exception {
assert resource instanceof MailSessionDescriptor;
final MailSessionDescriptor desc = (MailSessionDescriptor) resource;
String resourceName = ConnectorsUtil.deriveResourceName(desc.getResourceId(), desc.getName(), desc.getResourceType());
MailResource mailResource = new MyMailResource(desc,resourceName);
getDeployer(mailResource).deployResource(mailResource);
_logger.log(Level.FINE, "Mail-Session resource is deployed having resource-name [" + desc.getName() + "]");
}
@Override
public void undeployResource(Object resource) throws Exception {
assert resource instanceof MailSessionDescriptor;
final MailSessionDescriptor desc = (MailSessionDescriptor) resource;
String resourceName = ConnectorsUtil.deriveResourceName(desc.getResourceId(), desc.getName(),desc.getResourceType());
MailResource mailResource = new MyMailResource(desc, resourceName);
getDeployer(mailResource).undeployResource(mailResource);
_logger.log(Level.FINE, "Mail-Session resource is undeployed having resource-name [" + desc.getName() + "]");
}
@Override
public void undeployResource(Object resource, String applicationName, String moduleName) throws Exception {
//do nothing
}
@Override
public void redeployResource(Object resource) throws Exception {
throw new UnsupportedOperationException("redeploy() not supported for mail-session type");
}
@Override
public void enableResource(Object resource) throws Exception {
throw new UnsupportedOperationException("enable() not supported for mail-session type");
}
@Override
public void disableResource(Object resource) throws Exception {
throw new UnsupportedOperationException("disable() not supported for mail-session type");
}
@Override
public boolean handles(Object resource) {
return resource instanceof MailSessionDescriptor;
}
@Override
public boolean supportsDynamicReconfiguration() {
return false;
}
@Override
public Class[] getProxyClassesForDynamicReconfiguration() {
return new Class[0];
}
@Override
public boolean canDeploy(boolean postApplicationDeployment, Collection allResources, Resource resource) {
if (handles(resource)) {
if (!postApplicationDeployment) {
return true;
}
}
return false;
}
@Override
public void validatePreservedResource(Application oldApp, Application newApp, Resource resource, Resources allResources) throws ResourceConflictException {
}
private ResourceDeployer getDeployer(Object resource) {
return resourceManagerFactoryProvider.get().getResourceDeployer(resource);
}
public void registerMailSessions(com.sun.enterprise.deployment.Application application) {
String appName = application.getAppName();
Set bundles = application.getBundleDescriptors();
for (BundleDescriptor bundle : bundles) {
registerMailSessionDefinitions(appName, bundle);
Collection dds = bundle.getExtensionsDescriptors();
if (dds != null) {
for (RootDeploymentDescriptor dd : dds) {
registerMailSessionDefinitions(appName, dd);
}
}
}
}
private void registerMailSessionDefinitions(String appName, Descriptor descriptor) {
if (descriptor instanceof JndiNameEnvironment) {
JndiNameEnvironment env = (JndiNameEnvironment) descriptor;
for (Descriptor msd : env.getResourceDescriptors(JavaEEResourceType.MSD)) {
assert msd instanceof MailSessionDescriptor;
registerMSDReferredByApplication(appName, (MailSessionDescriptor)msd);
}
}
//ejb descriptor
if (descriptor instanceof EjbBundleDescriptor) {
EjbBundleDescriptor ejbDesc = (EjbBundleDescriptor) descriptor;
Set ejbDescriptors = (Set) ejbDesc.getEjbs();
for (EjbDescriptor ejbDescriptor : ejbDescriptors) {
for (Descriptor msd : ejbDescriptor.getResourceDescriptors(JavaEEResourceType.MSD)) {
assert msd instanceof MailSessionDescriptor;
registerMSDReferredByApplication(appName, (MailSessionDescriptor)msd);
}
}
//ejb interceptors
Set ejbInterceptors = ejbDesc.getInterceptors();
for (EjbInterceptor ejbInterceptor : ejbInterceptors) {
for (Descriptor msd : ejbInterceptor.getResourceDescriptors(JavaEEResourceType.MSD)) {
assert msd instanceof MailSessionDescriptor;
registerMSDReferredByApplication(appName, (MailSessionDescriptor)msd);
}
}
}
if (descriptor instanceof BundleDescriptor) {
// managed bean descriptors
Set managedBeanDescriptors = ((BundleDescriptor) descriptor).getManagedBeans();
for (ManagedBeanDescriptor mbd : managedBeanDescriptors) {
for (Descriptor msd : mbd.getResourceDescriptors(JavaEEResourceType.MSD)) {
assert msd instanceof MailSessionDescriptor;
registerMSDReferredByApplication(appName, (MailSessionDescriptor)msd);
}
}
}
}
private void registerMSDReferredByApplication(String appName,
MailSessionDescriptor msd) {
if (!msd.isDeployed()) {
CommonResourceProxy proxy = mailSessionProxyProvider.get();
org.glassfish.resourcebase.resources.naming.ResourceNamingService resourceNamingService = resourceNamingServiceProvider.get();
proxy.setDescriptor(msd);
if(msd.getName().startsWith(ConnectorConstants.JAVA_APP_SCOPE_PREFIX)){
msd.setResourceId(appName);
}
if (msd.getName().startsWith(ConnectorConstants.JAVA_GLOBAL_SCOPE_PREFIX)
|| msd.getName().startsWith(ConnectorConstants.JAVA_APP_SCOPE_PREFIX)) {
ResourceInfo resourceInfo = new ResourceInfo(msd.getName(), appName);
try {
resourceNamingService.publishObject(resourceInfo, proxy, true);
msd.setDeployed(true);
} catch (NamingException e) {
Object params[] = new Object[]{appName, msd.getName(), e};
_logger.log(Level.WARNING, "exception while registering mail-session ", params);
}
}
}
}
public void unRegisterMailSessions(com.sun.enterprise.deployment.Application application) {
Set bundles = application.getBundleDescriptors();
for (BundleDescriptor bundle : bundles) {
unRegisterMailSessions(bundle);
Collection dds = bundle.getExtensionsDescriptors();
if (dds != null) {
for (RootDeploymentDescriptor dd : dds) {
unRegisterMailSessions(dd);
}
}
}
}
private void unRegisterMailSessions(Descriptor descriptor) {
if (descriptor instanceof JndiNameEnvironment) {
JndiNameEnvironment env = (JndiNameEnvironment) descriptor;
for (Descriptor msd : env.getResourceDescriptors(JavaEEResourceType.MSD)) {
assert msd instanceof MailSessionDescriptor;
unRegisterMSDReferredByApplication((MailSessionDescriptor)msd);
}
}
//ejb descriptor
if (descriptor instanceof EjbBundleDescriptor) {
EjbBundleDescriptor ejbDesc = (EjbBundleDescriptor) descriptor;
Set ejbDescriptors = (Set) ejbDesc.getEjbs();
for (EjbDescriptor ejbDescriptor : ejbDescriptors) {
for (Descriptor msd : ejbDescriptor.getResourceDescriptors(JavaEEResourceType.MSD)) {
assert msd instanceof MailSessionDescriptor;
unRegisterMSDReferredByApplication((MailSessionDescriptor)msd);
}
}
//ejb interceptors
Set ejbInterceptors = ejbDesc.getInterceptors();
for (EjbInterceptor ejbInterceptor : ejbInterceptors) {
for (Descriptor msd : ejbInterceptor.getResourceDescriptors(JavaEEResourceType.MSD)) {
assert msd instanceof MailSessionDescriptor;
unRegisterMSDReferredByApplication((MailSessionDescriptor)msd);
}
}
}
// managed bean descriptors
if (descriptor instanceof BundleDescriptor) {
Set managedBeanDescriptors = ((BundleDescriptor) descriptor).getManagedBeans();
for (ManagedBeanDescriptor mbd : managedBeanDescriptors) {
for (Descriptor msd : mbd.getResourceDescriptors(JavaEEResourceType.MSD)) {
assert msd instanceof MailSessionDescriptor;
unRegisterMSDReferredByApplication((MailSessionDescriptor)msd);
}
}
}
}
private void unRegisterMSDReferredByApplication(MailSessionDescriptor msd) {
try {
if (msd.isDeployed()) {
undeployResource(msd);
}
} catch (Exception e) {
_logger.log(Level.WARNING, "exception while unregistering mail-session [ " + msd.getName() + " ]", e);
}
}
abstract class FakeConfigBean implements ConfigBeanProxy {
@Override
public ConfigBeanProxy deepCopy(ConfigBeanProxy parent) {
throw new UnsupportedOperationException();
}
@Override
public ConfigBeanProxy getParent() {
return null;
}
@Override
public T getParent(Class tClass) {
return null;
}
@Override
public T createChild(Class tClass) throws TransactionFailure {
return null;
}
}
class MailSessionProperty extends FakeConfigBean implements Property {
private String name;
private String value;
private String description;
MailSessionProperty(String name, String value) {
this.name = name;
this.value = value;
}
public String getName() {
return name;
}
public void setName(String value) throws PropertyVetoException {
this.name = value;
}
public String getValue() {
return TranslatedConfigView.expandValue(value);
}
public void setValue(String value) throws PropertyVetoException {
this.value = value;
}
public String getDescription() {
return description;
}
public void setDescription(String value) throws PropertyVetoException {
this.description = value;
}
public void injectedInto(Object o) {
//do nothing
}
}
/**
* A "fake" config bean with the same information as a
* config bean. The information for this fake config bean comes from
* a MailSessionDescriptor, which represents a @MailSessionDefinition
* annotation.
*/
class MyMailResource extends FakeConfigBean implements MailResource {
private MailSessionDescriptor desc;
private String name;
public MyMailResource(MailSessionDescriptor desc, String name) {
this.desc = desc;
this.name = name;
}
@Override
public String getStoreProtocol() {
return desc.getStoreProtocol();
}
@Override
public void setStoreProtocol(String value) throws PropertyVetoException {
//do nothing
}
@Override
public String getStoreProtocolClass() {
return desc.getProperty("mail." + getStoreProtocol() + ".class");
}
@Override
public void setStoreProtocolClass(String value) throws PropertyVetoException {
//do nothing
}
@Override
public String getTransportProtocol() {
return desc.getTransportProtocol();
}
@Override
public void setTransportProtocol(String value) throws PropertyVetoException {
//do nothing
}
@Override
public String getTransportProtocolClass() {
return desc.getProperty("mail." + getTransportProtocol() + ".class");
}
@Override
public void setTransportProtocolClass(String value) throws PropertyVetoException {
//do nothing
}
@Override
public String getHost() {
return TranslatedConfigView.expandValue(desc.getHost());
}
@Override
public void setHost(String value) throws PropertyVetoException {
//do nothing
}
@Override
public String getUser() {
return TranslatedConfigView.expandValue(desc.getUser());
}
@Override
public void setUser(String value) throws PropertyVetoException {
//do nothing
}
@Override
public String getPassword(){
return TranslatedConfigView.expandValue(desc.getPassword());
}
@Override
public void setPassword(String value){
//do nothing
}
@Override
public String getAuth(){
return desc.getAuth();
}
@Override
public void setAuth(String value) throws PropertyVetoException {
//do nothing
}
@Override
public String getFrom() {
return TranslatedConfigView.expandValue(desc.getFrom());
}
@Override
public void setFrom(String value) throws PropertyVetoException {
//do nothing
}
@Override
public String getDebug() {
return String.valueOf(true);
}
@Override
public void setDebug(String value) throws PropertyVetoException {
//do nothing
}
@Override
public String getJndiName() {
return name;
}
@Override
public void setJndiName(String value) throws PropertyVetoException {
//do nothing
}
@Override
public String getEnabled() {
return String.valueOf(true);
}
@Override
public void setEnabled(String value) throws PropertyVetoException {
//do nothing
}
@Override
public String getDescription() {
return desc.getDescription();
}
@Override
public void setDescription(String value) throws PropertyVetoException {
//do nothing
}
@Override
public List getProperty() {
// make a copy in the required format
List props = new ArrayList();
for (String key : desc.getProperties().stringPropertyNames())
props.add(new MailSessionProperty(key, desc.getProperty(key)));
return props;
}
@Override
public Property addProperty(Property property) {
throw new UnsupportedOperationException();
}
@Override
public Property lookupProperty(String s) {
throw new UnsupportedOperationException();
}
@Override
public Property removeProperty(String s) {
throw new UnsupportedOperationException();
}
@Override
public Property removeProperty(Property property) {
throw new UnsupportedOperationException();
}
@Override
public Property getProperty(String name) {
return new MailSessionProperty(name, desc.getProperty(name));
}
@Override
public String getPropertyValue(String name) {
return desc.getProperty(name);
}
@Override
public String getPropertyValue(String name, String defaultValue) {
String v = desc.getProperty(name);
return v != null ? v : defaultValue;
}
@Override
public String getObjectType() {
return null;
}
@Override
public void setObjectType(String value) throws PropertyVetoException {
//do nothing
}
@Override
public String getIdentity() {
return name;
}
@Override
public String getDeploymentOrder() {
return null;
}
@Override
public void setDeploymentOrder(String value) {
//do nothing
}
}
}