AppserverIo\Psr\Naming\EnterpriseBeanResourceIdentifier

Complexity

Total Complexity

14

Size/Duplication

Total Lines	217
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

36.36%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	getSupportedMembers()	0	4	1
A	setIndexFile()	0	4	1
A	getIndexFile()	0	4	1
A	setContextName()	0	4	1
A	getContextName()	0	4	1
A	setClassName()	0	4	1
A	getClassName()	0	4	1
A	setInterface()	0	4	1
A	getInterface()	0	4	1
A	isLocal()	0	4	1
A	isRemote()	0	4	1
A	setTransport()	0	4	1
A	getTransport()	0	4	1
A	createFromProperties()	0	4	1

<?php

/**
 * \AppserverIo\Psr\Naming\EnterpriseBeanResourceIdentifier
 *
 * 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>
 * @copyright  2015 TechDivision GmbH <info@appserver.io>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       https://github.com/appserver-io-psr/naming
 * @link       http://www.appserver.io
 */

namespace AppserverIo\Psr\Naming;

use AppserverIo\Properties\PropertiesInterface;

/**
 * This is a resource identifier implementation that supports a JNDI like
 * syntax to create a resource identifier for enterprise beans.
 *
 * @author     Tim Wagner <tw@appserver.io>
 * @copyright  2015 TechDivision GmbH <info@appserver.io>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       https://github.com/appserver-io-psr/naming
 * @link       http://www.appserver.io
 */
class EnterpriseBeanResourceIdentifier extends ResourceIdentifier
{

    /**
     * The key for the local business interface.
     *
     * @var string
     */
    const LOCAL_INTERFACE = 'local';

    /**
     * The key for the remote business interface.
     *
     * @var string
     */
    const REMOTE_INTERFACE = 'remote';

    /**
     * Identifier for property name 'contextName'.
     *
     * @var string
     */
    const PROPERTY_CONTEXT_NAME = 'contextName';

    /**
     * Identifier for property name 'className'.
     *
     * @var string
     */
    const PROPERTY_CLASS_NAME = 'className';

    /**
     * Identifier for property name 'interface'.
     *
     * @var string
     */
    const PROPERTY_INTERFACE = 'interface';

    /**
     * Identifier for property name 'indexFile'.
     *
     * @var string
     */
    const PROPERTY_INDEX_FILE = 'indexFile';

    /**
     * Identifier for property name 'transport'.
     *
     * @var string
     */
    const PROPERTY_TRANSPORT = 'transport';

    /**
     * The array with the members we want to parse from a URL.
     *
     * @var array
     */
    protected $supportedMembers = array(
        EnterpriseBeanResourceIdentifier::PROPERTY_CONTEXT_NAME,
        EnterpriseBeanResourceIdentifier::PROPERTY_CLASS_NAME,
        EnterpriseBeanResourceIdentifier::PROPERTY_INDEX_FILE,
        EnterpriseBeanResourceIdentifier::PROPERTY_INTERFACE,
        EnterpriseBeanResourceIdentifier::PROPERTY_TRANSPORT
    );

    /**
     * Returns the array with the supported members.
     *
     * @return array The array with the supported members
     */
    protected function getSupportedMembers()
    {
        return $this->supportedMembers;
    }

    /**
     * Sets the name of the index file.
     *
     * @param string $indexFile The name of the index file
     *
     * @return void
     */
    public function setIndexFile($indexFile)
    {
        $this->setValue(EnterpriseBeanResourceIdentifier::PROPERTY_INDEX_FILE, $indexFile);
    }

    /**
     * Returns the name of the index file.
     *
     * @return string|null The name of the index file
     */
    public function getIndexFile()
    {
        return $this->getValue(EnterpriseBeanResourceIdentifier::PROPERTY_INDEX_FILE);
    }

    /**
     * Sets the context name.
     *
     * @param string $contextName The context name
     *
     * @return void
     */
    public function setContextName($contextName)
    {
        $this->setValue(EnterpriseBeanResourceIdentifier::PROPERTY_CONTEXT_NAME, $contextName);
    }

    /**
     * Returns the context name.
     *
     * @return string|null The context name
     */
    public function getContextName()
    {
        return $this->getValue(EnterpriseBeanResourceIdentifier::PROPERTY_CONTEXT_NAME);
    }

    /**
     * Sets the enterprise beans class name.
     *
     * @param string $className The enterprise bean class name
     *
     * @return void
     */
    public function setClassName($className)
    {
        $this->setValue(EnterpriseBeanResourceIdentifier::PROPERTY_CLASS_NAME, $className);
    }

    /**
     * Returns the enterprise beans class name.
     *
     * @return string|null The enterprise bean class name
     */
    public function getClassName()
    {
        return $this->getValue(EnterpriseBeanResourceIdentifier::PROPERTY_CLASS_NAME);
    }

    /**
     * Sets the name of the interface.
     *
     * @param string $interface The name of the interface
     *
     * @return void
     */
    public function setInterface($interface)
    {
        $this->setValue(EnterpriseBeanResourceIdentifier::PROPERTY_INTERFACE, $interface);
    }

    /**
     * Returns the name of the interface.
     *
     * @return string|null The name of the interface
     */
    public function getInterface()
    {
        return $this->getValue(EnterpriseBeanResourceIdentifier::PROPERTY_INTERFACE);
    }

    /**
     * Queries whether the resource identifier requests a local interface or not.
     *
     * @return boolean TRUE if resource identifier requests a local interface
     */
    public function isLocal()
    {
        return $this->getInterface() === EnterpriseBeanResourceIdentifier::LOCAL_INTERFACE;
    }

    /**
     * Queries whether the resource identifier requests a remote interface or not.
     *
     * @return boolean TRUE if resource identifier requests a remote interface
     */
    public function isRemote()
    {
        return $this->getInterface() === EnterpriseBeanResourceIdentifier::REMOTE_INTERFACE;
    }

    /**
     * Sets the transport protocol for remote interface handling.
     *
     * @param string $transport The transport protocol for remote interface handling
     *
     * @return void
     */
    public function setTransport($transport)
    {
        $this->setValue(EnterpriseBeanResourceIdentifier::PROPERTY_TRANSPORT, $transport);
    }

    /**
     * Returns the transport protocol for remote interface handling.
     *
     * @return string|null The transport protocol for remote interface handling
     */
    public function getTransport()
    {
        return $this->getValue(EnterpriseBeanResourceIdentifier::PROPERTY_TRANSPORT);
    }

    /**
     * create a new resource identifier with the URL parts from the passed properties.
     *
     * @param \AppserverIo\Properties\PropertiesInterface $properties The configuration properties
     *
     * @return \AppserverIo\Psr\Naming\EnterpriseBeanResourceIdentifier The initialized instance
     */
    public static function createFromProperties(PropertiesInterface $properties)
    {
        return new EnterpriseBeanResourceIdentifier($properties->toIndexedArray());
    }
}