com.genexus.gxserver.client.clients.ServerHelperClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gxserver-client Show documentation
Java client for GeneXus Server services
The newest version!
/*
 * The MIT License
 *
 * Copyright 2020 GeneXus S.A..
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.genexus.gxserver.client.clients;

import com.genexus.gxserver.client.clients.common.ServiceData;
import com.genexus.gxserver.client.clients.common.ServiceInfo;
import com.genexus.gxserver.client.clients.common.TransferPropConstants;
import com.genexus.gxserver.client.clients.common.TransferPropHelper;
import com.genexus.gxserver.client.clients.common.WithLocalContextClassLoader;
import com.genexus.gxserver.client.info.ServerInfo;
import com.genexus.gxserver.client.services.contracts.ArrayOfServerMessage;
import com.genexus.gxserver.client.services.contracts.ArrayOfTransferProp;
import com.genexus.gxserver.client.services.contracts.TransferProp;
import com.genexus.gxserver.client.services.helper.IServerHelper;
import com.genexus.gxserver.client.services.helper.IServerHelperIsServerAliveGXServerExceptionFaultFaultMessage;
import com.genexus.gxserver.client.services.helper.IServerHelperServerInfoGXServerExceptionFaultFaultMessage;
import com.genexus.gxserver.client.services.helper.ServerHelper;
import com.genexus.gxserver.client.services.helper.SimpleTransfer;
import jakarta.xml.ws.BindingProvider;
import jakarta.xml.ws.Holder;
import java.io.IOException;
import java.net.MalformedURLException;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 *
 * @author jlr
 */
public class ServerHelperClient extends BaseClient {

    private static final ServiceInfo SERVER_HELPER_INFO = new ServiceInfo(
            "HelperService.svc/secure",
            "HelperService.svc",
            "CustomBinding_IServerHelper",
            "BasicHttpBinding_IServerHelper"
    );

    @Override
    protected ServiceInfo getServiceInfo() {
        return SERVER_HELPER_INFO;
    }

    public ServerHelperClient(String serverURL) throws MalformedURLException {
        this(new ServiceData(serverURL, "", ""));
    }

    public ServerHelperClient(ServiceData serviceData) throws MalformedURLException {
        super(serviceData, /* useNotSecure = */ true);
    }

    private LocalContextServiceWrapper serverHelper = null;

    private LocalContextServiceWrapper getServerHelper() throws IOException {
        if (serverHelper == null) {
            BindingData binding = getBindingData();

            IServerHelper port = WithLocalContextClassLoader.call(() -> {
                ServerHelper service = new ServerHelper();
                return binding.isSecure
                        ? service.getCustomBindingIServerHelper()
                        : service.getBasicHttpBindingIServerHelper();
            });

            prepareClient((BindingProvider) port);

            serverHelper = new LocalContextServiceWrapper(port);
        }
        return serverHelper;
    }

    public Boolean isServerAlive() throws IOException {
        try {
            return getServerHelper().isServerAlive(getClientVersion());
        } catch (IServerHelperIsServerAliveGXServerExceptionFaultFaultMessage ex) {
            Logger.getLogger(ServerHelperClient.class.getName()).log(Level.SEVERE, null, ex);
            throw new IOException("Error accessing GXserver", ex);
        }
    }

    private static final Logger LOGGER = Logger.getLogger(ServerHelperClient.class.getName());

    public ServerInfo getServerInfo() throws IOException {
        try {
            Holder parameters = new Holder<>(new SimpleTransfer());
            Holder messages = new Holder<>(new ArrayOfServerMessage());
            Holder properties = new Holder<>(new ArrayOfTransferProp());

            properties.value.getTransferProp().add(
                    TransferPropHelper.createStringProp(TransferPropConstants.CLIENT_GXVERSION, getClientVersion())
            );

            properties.value.getTransferProp().add(
                    TransferPropHelper.createStringProp(TransferPropConstants.SERVER_OPERATION, "")
            );

            getServerHelper().serverInfo(parameters, messages, properties);

            ServerInfo serverInfo = new ServerInfo();

            for (TransferProp prop : properties.value.getTransferProp()) {
                switch (prop.getName()) {
                    case TransferPropConstants.SERVER_GXVERSION:
                        serverInfo.serverVersion = TransferPropHelper.getStringValue(prop);
                        break;

                    case TransferPropConstants.SERVER_AVAILABLE:
                        serverInfo.isAvailable = TransferPropHelper.getBooleanValue(prop);
                        break;

                    case TransferPropConstants.SERVER_SECURE:
                        serverInfo.isSecure = TransferPropHelper.getBooleanValue(prop);
                        break;
                    case TransferPropConstants.SUPPORTS_TOKEN_AUTHENTICATION:
                        serverInfo.supportsTokenAuthentication = TransferPropHelper.getBooleanValue(prop);
                        break;

                    case TransferPropConstants.ALLOWS_GXTEST:
                        serverInfo.allowsGXtest = TransferPropHelper.getBooleanValue(prop);
                        break;

                    case TransferPropConstants.SERVER_CUSTOM_BINDING:
                        serverInfo.allowsCustomBinding = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.REST_SERVICES_API_VERSION:
                        serverInfo.restServicesAPIVersion = TransferPropHelper.getIntValue(prop);
                        break;

                    case TransferPropConstants.SERVER_ALLOW_SOURCE_CHECKSUM:
                        serverInfo.allowsSourceChecksum = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.SERVER_ALLOW_PARTIAL_UPDATE:
                        serverInfo.allowsPartialUpdate = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.SERVER_ALLOW_OBJECT_LOCK:
                        serverInfo.allowsObjectLock = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.SERVER_ALLOW_ADVANCED_VERSIONS:
                        serverInfo.allowsAdvancedVersions = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.SERVER_EXPECTS_RECEIVE_LAST_UPDATE_DATE:
                        serverInfo.expectsReceiveLastUpdateDate = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.SERVER_ALLOW_ADVANCED_CHECKOUT:
                        serverInfo.allowsAdvancedCheckout = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.SERVER_ALLOW_BCH_REMIND:
                        serverInfo.allowsBCHRemind = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.SERVER_VERSION_MANAGE_SUPPORT:
                        serverInfo.allowsVersionManagement = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.SERVER_ALLOW_ADVANCED_HOSTED_KB:
                        serverInfo.allowsAdvancedHostedKB = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.SERVER_ALLOW_OBJECT_SHOW_DIFFERENCE:
                        serverInfo.allowsObjectShowDifference = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.SERVER_SUPPORT_METADATA_ACTIONS:
                        serverInfo.supportsMetadataActions = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.USES_NEW_PERMISSIONS_NAME:
                        serverInfo.usesNewPermissionsName = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.USES_TOLEDO_URL_FORMAT:
                        serverInfo.usesToledoUrlFormat = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.ALLOW_CHECKOUT_VERSION:
                        serverInfo.allowsCheckoutVersion = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.SUPPORT_EXPLORE_REMOTE_KB:
                        serverInfo.supportsExploreRemoteKb = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    case TransferPropConstants.SUPPORT_CONTINUOUS_INTEGRATION:
                        serverInfo.supportsContinuousIntegration = TransferPropHelper.getBooleanValue(prop);
                        break;
                        
                    default:
                        Logger.getLogger(ServerHelperClient.class.getName()).log(Level.WARNING, "Unknown server property: {0}", prop.getName());
                }
            }

            return serverInfo;
        } catch (IServerHelperServerInfoGXServerExceptionFaultFaultMessage | IOException ex) {
            Logger.getLogger(ServerHelperClient.class.getName()).log(Level.SEVERE, null, ex);
            throw new IOException("Error accessing GXserver", ex);
        }
    }

    private static class LocalContextServiceWrapper {

        private final IServerHelper service;

        LocalContextServiceWrapper(IServerHelper service) {
            this.service = service;
        }

        public Boolean isServerAlive(String clientVersion) throws IServerHelperIsServerAliveGXServerExceptionFaultFaultMessage {
            return WithLocalContextClassLoader.call(() -> service.isServerAlive(clientVersion));
        }

        private void serverInfo(Holder parameters, Holder messages, Holder properties) throws IServerHelperServerInfoGXServerExceptionFaultFaultMessage {
            WithLocalContextClassLoader.call(() -> {
                service.serverInfo(parameters, messages, properties);
                return 0;  // no actual value to return
            });
        }
    }
}