Class Mage_Api2_Model_Server

API2 Server

Package: Mage\Api2
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Api2/Model/Server.php

Methods summary
`public`	# `run( )` Run server Run server
`public Mage_Api2_Model_Response`	# `internalCall( Mage_Api2_Model_Request $request, Mage_Api2_Model_Response $response )` Make internal call to api Make internal call to api Parameters `$request` `Mage_Api2_Model_Request` $request `$response` `Mage_Api2_Model_Response` $response Returns `Mage_Api2_Model_Response`
`protected Mage_Api2_Model_Auth_User_Abstract`	# `_authenticate( Mage_Api2_Model_Request $request )` Authenticate user Authenticate user Parameters `$request` `Mage_Api2_Model_Request` $request Returns `Mage_Api2_Model_Auth_User_Abstract` Throws `Exception`
`protected Mage_Api2_Model_Server`	# `_setAuthUser( Mage_Api2_Model_Auth_User_Abstract $authUser )` Set auth user Set auth user Parameters `$authUser` `Mage_Api2_Model_Auth_User_Abstract` $authUser Returns `Mage_Api2_Model_Server` Throws `Exception`
`protected Mage_Api2_Model_Auth_User_Abstract`	# `_getAuthUser( )` Retrieve existing auth user Retrieve existing auth user Returns `Mage_Api2_Model_Auth_User_Abstract` Throws `Exception`
`protected Mage_Api2_Model_Server`	# `_route( Mage_Api2_Model_Request $request )` Set all routes of the given api type to Route object Find route that match current URL, set parameters of the route to Request object Set all routes of the given api type to Route object Find route that match current URL, set parameters of the route to Request object Parameters `$request` `Mage_Api2_Model_Request` $request Returns `Mage_Api2_Model_Server`
`protected Mage_Api2_Model_Server`	# `_allow( Mage_Api2_Model_Request $request, Mage_Api2_Model_Auth_User_Abstract $apiUser )` Global ACL processing Global ACL processing Parameters `$request` `Mage_Api2_Model_Request` $request `$apiUser` `Mage_Api2_Model_Auth_User_Abstract` $apiUser Returns `Mage_Api2_Model_Server` Throws `Mage_Api2_Exception`
`protected Mage_Api2_Model_Server`	# `_dispatch( Mage_Api2_Model_Request $request, Mage_Api2_Model_Response $response, Mage_Api2_Model_Auth_User_Abstract $apiUser )` Load class file, instantiate resource class, set parameters to the instance, run resource internal dispatch method Load class file, instantiate resource class, set parameters to the instance, run resource internal dispatch method Parameters `$request` `Mage_Api2_Model_Request` $request `$response` `Mage_Api2_Model_Response` $response `$apiUser` `Mage_Api2_Model_Auth_User_Abstract` $apiUser Returns `Mage_Api2_Model_Server`
`protected Mage_Api2_Model_Config`	# `_getConfig( )` Get api2 config instance Get api2 config instance Returns `Mage_Api2_Model_Config`
`protected Mage_Api2_Model_Server`	# `_renderException( Exception $exception, Mage_Api2_Model_Renderer_Interface $renderer, Mage_Api2_Model_Response $response )` Process thrown exception Generate and set HTTP response code, error message to Response object Process thrown exception Generate and set HTTP response code, error message to Response object Parameters `$exception` `Exception` $exception `$renderer` `Mage_Api2_Model_Renderer_Interface` $renderer `$response` `Mage_Api2_Model_Response` $response Returns `Mage_Api2_Model_Server`
`public static array`	# `getApiTypes( )` Retrieve api types Retrieve api types Returns `array`

Constants summary
`string`	`API_TYPE_REST`	`'rest'`	# Api2 REST type Api2 REST type
`integer`	`HTTP_OK`	`200`	# HTTP Response Codes HTTP Response Codes
`integer`	`HTTP_CREATED`	`201`	#
`integer`	`HTTP_MULTI_STATUS`	`207`	#
`integer`	`HTTP_BAD_REQUEST`	`400`	#
`integer`	`HTTP_UNAUTHORIZED`	`401`	#
`integer`	`HTTP_FORBIDDEN`	`403`	#
`integer`	`HTTP_NOT_FOUND`	`404`	#
`integer`	`HTTP_METHOD_NOT_ALLOWED`	`405`	#
`integer`	`HTTP_NOT_ACCEPTABLE`	`406`	#
`integer`	`HTTP_INTERNAL_ERROR`	`500`	#

Properties summary
`protected static array`	`$_apiTypes`	`array(self::API_TYPE_REST)`	# List of api types List of api types
`protected Mage_Api2_Model_Auth_User_Abstract`	`$_authUser`		#

Packages

Classes

Interfaces

Exceptions

Class Mage_Api2_Model_Server

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Returns

Parameters

Returns

Returns