appserver-io / appserver

src/AppserverIo/Appserver/Core/AbstractEpbManager.php

<?php

/**
 * \AppserverIo\Appserver\Core\AbstractEpbManager
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author     Tim Wagner <tw@appserver.io>
 * @author     Bernhard Wick <bw@appserver.io>
 * @copyright  2016 TechDivision GmbH - <info@appserver.io>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       http://www.appserver.io/
 */

namespace AppserverIo\Appserver\Core;

use AppserverIo\Psr\Naming\NamingException;
use AppserverIo\Psr\Di\ObjectManagerInterface;
use AppserverIo\RemoteMethodInvocation\LocalProxy;
use AppserverIo\Appserver\ServletEngine\RequestHandler;
use AppserverIo\Psr\Deployment\DescriptorInterface;
use AppserverIo\Psr\EnterpriseBeans\BeanContextInterface;
use AppserverIo\Psr\EnterpriseBeans\PersistenceContextInterface;
use AppserverIo\Psr\EnterpriseBeans\Description\EpbReferenceDescriptorInterface;
use AppserverIo\Psr\EnterpriseBeans\Description\ResReferenceDescriptorInterface;
use AppserverIo\Psr\EnterpriseBeans\Description\BeanReferenceDescriptorInterface;
use AppserverIo\Psr\EnterpriseBeans\Description\PersistenceUnitReferenceDescriptorInterface;

/**
 * Abstract manager which is able to handle EPB, resource and persistence unit registrations.
 *
 * @author     Tim Wagner <tw@appserver.io>
 * @author     Bernhard Wick <bw@appserver.io>
 * @copyright  2016 TechDivision GmbH - <info@appserver.io>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       http://www.appserver.io/
 */
abstract class AbstractEpbManager extends AbstractManager
{

    /**
     * Register's the references of the passed descriptor.
     *
     * @param \AppserverIo\Psr\Deployment\DescriptorInterface $descriptor The descriptor to register the references for
     *
     * @return void
     */
    public function registerReferences(DescriptorInterface $descriptor)
    {

        //  register the EPB references
        foreach ($descriptor->getEpbReferences() as $epbReference) {

The method getEpbReferences() does not exist on AppserverIo\Psr\Deployment\DescriptorInterface. It seems like you code against a sub-type of AppserverIo\Psr\Deployment\DescriptorInterface such as AppserverIo\Ldap\Description\RepositoryDescriptorInterface or AppserverIo\Description\BeanDescriptor or AppserverIo\Description\EnterpriseBeanDescriptor or AppserverIo\Description\ServletDescriptor.

            $this->registerEpbReference($epbReference);
        }

        // register the resource references
        foreach ($descriptor->getResReferences() as $resReference) {

The method getResReferences() does not exist on AppserverIo\Psr\Deployment\DescriptorInterface. It seems like you code against a sub-type of AppserverIo\Psr\Deployment\DescriptorInterface such as AppserverIo\Ldap\Description\RepositoryDescriptorInterface or AppserverIo\Description\BeanDescriptor or AppserverIo\Description\EnterpriseBeanDescriptor or AppserverIo\Description\ServletDescriptor.

            $this->registerResReference($resReference);
        }

        // register the bean references
        foreach ($descriptor->getBeanReferences() as $beanReference) {

The method getBeanReferences() does not exist on AppserverIo\Psr\Deployment\DescriptorInterface. It seems like you code against a sub-type of AppserverIo\Psr\Deployment\DescriptorInterface such as AppserverIo\Ldap\Description\RepositoryDescriptorInterface or AppserverIo\Description\BeanDescriptor or AppserverIo\Description\EnterpriseBeanDescriptor or AppserverIo\Description\ServletDescriptor.

            $this->registerBeanReference($beanReference);
        }

        // register the persistence unit references
        foreach ($descriptor->getPersistenceUnitReferences() as $persistenceUnitReference) {

The method getPersistenceUnitReferences() does not exist on AppserverIo\Psr\Deployment\DescriptorInterface. It seems like you code against a sub-type of AppserverIo\Psr\Deployment\DescriptorInterface such as AppserverIo\Ldap\Description\RepositoryDescriptorInterface or AppserverIo\Description\BeanDescriptor or AppserverIo\Description\EnterpriseBeanDescriptor or AppserverIo\Description\ServletDescriptor.

            $this->registerPersistenceUnitReference($persistenceUnitReference);
        }
    }

    /**
     * Registers the passed EPB reference in the applications directory.
     *
     * @param \AppserverIo\Psr\EnterpriseBeans\Description\EpbReferenceDescriptorInterface $epbReference The EPB reference to register
     *
     * @return void
     */
    public function registerEpbReference(EpbReferenceDescriptorInterface $epbReference)
    {

        try {
            // load the application instance and reference name
            $application = $this->getApplication();
            $name = $epbReference->getRefName();

            // initialize the bean's URI
            $uri = sprintf('php:global/%s/%s', $application->getUniqueName(), $name);

The method getUniqueName() does not exist on AppserverIo\Psr\Application\ApplicationInterface. It seems like you code against a sub-type of AppserverIo\Psr\Application\ApplicationInterface such as AppserverIo\Appserver\Application\Application.

            // query whether the reference has already been bound to the application
            if ($application->getNamingDirectory()->isBound($uri)) {

The method getNamingDirectory() does not exist on AppserverIo\Psr\Application\ApplicationInterface. It seems like you code against a sub-type of AppserverIo\Psr\Application\ApplicationInterface such as AppserverIo\Appserver\Application\Application.

                // log a message that the reference has already been bound
                $application->getInitialContext()->getSystemLogger()->debug(

The method getInitialContext() does not exist on AppserverIo\Psr\Application\ApplicationInterface. It seems like you code against a sub-type of AppserverIo\Psr\Application\ApplicationInterface such as AppserverIo\Appserver\Application\Application.

                    sprintf('Enterprise bean reference %s has already been bound to naming directory', $uri)
                );

                // return immediately
                return;
            }

            // this has to be refactored, because it'll be quite faster to inject either
            // the remote/local proxy instance as injection a callback that creates the
            // proxy on-the-fly!

            // query whether or not we've a lookup name specified
            if ($lookup = $epbReference->getLookup()) {
                // create a reference to a bean in the global directory
                $application->getNamingDirectory()->bind($uri, array(&$this, 'lookup'), array($lookup));

            // try to load the bean name, if no lookup name has been specified
            } elseif ($beanName = $epbReference->getBeanName()) {
                // query whether we've a local business interface
                if ($epbReference->getBeanInterface() === sprintf('%sLocal', $beanName)) {
                    // bind the local business interface of the bean to the appliations naming directory
                    $application->getNamingDirectory()
                                ->bind(
                                    $uri,
                                    array(&$this, 'lookupProxy'),
                                    array(sprintf('%s/local', $beanName))
                                );

                // query whether we've a remote business interface
                } elseif ($epbReference->getBeanInterface() === (sprintf('%sRemote', $beanName))) {
                    // bind the remote business interface of the bean to the applications naming directory
                    $application->getNamingDirectory()
                                ->bind(
                                    $uri,
                                    array(&$this, 'lookupProxy'),
                                    array(sprintf('%s/remote', $beanName))
                                );

                // at least, we need a business interface
                } else {
                    // log a critical message that we can't bind the reference
                    $application->getInitialContext()->getSystemLogger()->critical(
                        sprintf('Can\'t bind bean reference %s to naming directory', $uri)
                    );
                }

            } else {
                $application->getInitialContext()->getSystemLogger()->critical(
                    sprintf('Can\'t bind enterprise bean reference %s to naming directory, because of missing lookup/bean name', $uri)
                );
            }

        // catch all other exceptions
        } catch (\Exception $e) {
            $application->getInitialContext()->getSystemLogger()->critical($e->__toString());
        }
    }

    /**
     * Registers the passed resource reference in the applications directory.
     *
     * @param \AppserverIo\Psr\EnterpriseBeans\Description\ResReferenceDescriptorInterface $resReference The resource reference to register
     *
     * @return void
     */
    public function registerResReference(ResReferenceDescriptorInterface $resReference)
    {
        try {
            // load the application instance and reference name
            $application = $this->getApplication();

            // initialize the resource URI
            $uri = sprintf('php:global/%s/%s', $application->getUniqueName(), $resReference->getRefName());

            // query whether the reference has already been bound to the application
            if ($application->getNamingDirectory()->isBound($uri)) {
                // log a message that the reference has already been bound
                $application->getInitialContext()->getSystemLogger()->debug(
                    sprintf('Resource reference %s has already been bound to naming directory', $uri)
                );

                // return immediately
                return;
            }

        // catch the NamingException if the ref name is not bound yet
        } catch (NamingException $e) {
            // log a message that we've to register the resource reference now
            $application->getInitialContext()->getSystemLogger()->debug(
                sprintf('Resource reference %s has not been bound to naming directory', $uri)

The variable $uri does not seem to be defined for all execution paths leading up to this point.

            );
        }

        try {
            // try to use the lookup to bind the reference to
            if ($lookup = $resReference->getLookup()) {
                // create a reference to a resource in the global directory
                $application->getNamingDirectory()->bindReference($uri, $lookup);

            // try to bind the reference by the specified type
            } elseif ($type = $resReference->getType()) {
                // bind a reference to the resource shortname
                $application->getNamingDirectory()
                            ->bindReference(
                                $uri,
                                sprintf('php:global/%s/%s', $application->getUniqueName(), $type)
                            );

            // log a critical message that we can't bind the reference
            } else {
                $application->getInitialContext()->getSystemLogger()->critical(
                    sprintf('Can\'t bind resource reference %s to naming directory, because of missing source bean/lookup name', $uri)
                );
            }

        // catch all other exceptions
        } catch (\Exception $e) {
            $application->getInitialContext()->getSystemLogger()->critical($e->__toString());
        }
    }

    /**
     * Registers the passed bean reference in the applications directory.
     *
     * @param \AppserverIo\Psr\EnterpriseBeans\Description\BeanReferenceDescriptorInterface $beanReference The bean reference to register
     *
     * @return void
     */
    public function registerBeanReference(BeanReferenceDescriptorInterface $beanReference)
    {
        try {
            // load the application instance and reference name
            $application = $this->getApplication();

            // initialize the class URI
            $uri = sprintf('php:global/%s/%s', $application->getUniqueName(), $beanReference->getRefName());

            // query whether the reference has already been bound to the application
            if ($application->getNamingDirectory()->isBound($uri)) {
                // log a message that the reference has already been bound
                $application->getInitialContext()->getSystemLogger()->debug(
                    sprintf('Bean reference %s has already been bound to naming directory', $uri)
                );

                // return immediately
                return;
            }

        // catch the NamingException if the ref name is not bound yet
        } catch (NamingException $e) {
            // log a message that we've to register the bean reference now
            $application->getInitialContext()->getSystemLogger()->debug(
                sprintf('Bean reference %s has not been bound to naming directory', $uri)

The variable $uri does not seem to be defined for all execution paths leading up to this point.

            );
        }

        try {
            // try to bind the bean by the specified bean name
            if ($beanName = $beanReference->getBeanName()) {
                // bind a reference to the class type
                $application->getNamingDirectory()
                            ->bind(
                                $uri,
                                array(&$this, 'lookupBean'),
                                array($beanName)
                            );

            // log a critical message that we can't bind the reference
            } else {
                $application->getInitialContext()->getSystemLogger()->critical(
                    sprintf('Can\'t bind bean reference %s to naming directory, because of missing source bean name', $uri)
                );
            }

        // catch all other exceptions
        } catch (\Exception $e) {
            $application->getInitialContext()->getSystemLogger()->critical($e->__toString());
        }
    }

    /**
     * Registers the passed persistence unit reference in the applications directory.
     *
     * @param \AppserverIo\Psr\EnterpriseBeans\Description\PersistenceUnitReferenceDescriptorInterface $persistenceUnitReference The persistence unit reference to register
     *
     * @return void
     */
    public function registerPersistenceUnitReference(PersistenceUnitReferenceDescriptorInterface $persistenceUnitReference)
    {
        try {
            // load the application instance and reference name
            $application = $this->getApplication();

            // initialize the persistence unit URI
            $uri = sprintf('php:global/%s/%s', $application->getUniqueName(), $persistenceUnitReference->getRefName());

            // query whether the reference has already been bound to the application
            if ($application->getNamingDirectory()->isBound($uri)) {
                // log a message that the reference has already been bound
                $application->getInitialContext()->getSystemLogger()->debug(
                    sprintf('Persistence unit reference %s has already been bound to naming directory', $uri)
                );

                // return immediately
                return;
            }

        // catch the NamingException if the ref name is not bound yet
        } catch (NamingException $e) {
            // log a message that we've to register the resource reference now
            $application->getInitialContext()->getSystemLogger()->debug(
                sprintf('Persistence unit reference %s has not been bound to naming directory', $uri)

The variable $uri does not seem to be defined for all execution paths leading up to this point.

            );
        }

        try {
            // try to use the unit name to bind the reference to
            if ($unitName = $persistenceUnitReference->getUnitName()) {
                // load the persistenc manager to bind the callback to
                $persistenceManager = $application->search(PersistenceContextInterface::IDENTIFIER);
                // create a reference to a persistence unit in the global directory
                $application->getNamingDirectory()
                            ->bind(
                                $uri,
                                array(&$persistenceManager, 'lookupProxy'),
                                array($unitName)
                            );

            // log a critical message that we can't bind the reference
            } else {
                $application->getInitialContext()->getSystemLogger()->critical(
                    sprintf('Can\'t bind persistence unit Reference %s to naming directory, because of missing unit name definition', $uri)
                );
            }

        // catch all other exceptions
        } catch (\Exception $e) {
            $application->getInitialContext()->getSystemLogger()->critical($e->__toString());
        }
    }

    /**
     * This returns an instance of the requested bean.
     *
     * @param string $lookupName The lookup name for the requested bean
     *
     * @return object The bean instance
     */
    public function lookupBean($lookupName)
    {
        return $this->getApplication()->search($lookupName);
    }

    /**
     * This returns a proxy to the requested session bean. If the proxy has already been
     * instanciated for the actual request, the existing instance will be returned.
     *
     * @param string $lookupName The lookup name for the requested session bean
     *
     * @return \AppserverIo\RemoteMethodInvocation\RemoteObjectInterface The proxy instance
     */
    public function lookupProxy($lookupName)
    {

        // load the initial context instance
        $initialContext = $this->getInitialContext();

        // query whether a request context is available
        if ($servletRequest = RequestHandler::getRequestContext()) {
            // inject the servlet request to handle SFSBs correctly
            $initialContext->injectServletRequest($servletRequest);
        }

        // return the proxy instance
        return $initialContext->lookup($lookupName);
    }

    /**
     * This returns a local proxy to the requested session bean.
     *
     * @param string $lookupName The lookup name for the requested session bean
     *
     * @return \AppserverIo\RemoteMethodInvocation\RemoteObjectInterface The proxy instance
     */
    public function lookupLocalProxy($lookupName)
    {

        // extract the session bean name from the lookup name
        $beanName = str_replace('/local', '', $lookupName);

        // load the application
        $application = $this->getApplication();

        // load bean and object manager
        $beanManager = $application->search(BeanContextInterface::IDENTIFIER);
        $objectManager = $application->search(ObjectManagerInterface::IDENTIFIER);

        // load the requested session bean
        $sessionBean = $application->search($beanName);

        // load the bean descriptor
        $sessionBeanDescriptor = $objectManager->getObjectDescriptors()->get(get_class($sessionBean));

        // initialize the local proxy instance
        return new LocalProxy(

The call to AppserverIo\RemoteMethodInvocation\LocalProxy::__construct() has too few arguments starting with sessionId.

            $beanManager,
            $sessionBeanDescriptor,
            $sessionBean
        );
    }
}