de.hybris.platform.oci.jalo

Class OciManager

java.lang.Object

de.hybris.platform.jalo.Manager

de.hybris.platform.jalo.extension.Extension

de.hybris.platform.oci.jalo.GeneratedOciManager

de.hybris.platform.oci.jalo.OciManager

All Implemented Interfaces:

Serializable

public class OciManager
extends GeneratedOciManager

This is the extension manager of the OCI extension.
The OCI extension is an interface which provides methods for communicating from a SAP SRM Server to a (hybris) catalog.

The SAP Server sends requests and data (such as search strings, ids, ...) per http POST and the oci extension response with URL redirects (for example: product detail page) or http forms with included xml data.

The oci extension support the version OCI2.x, OCI3.x, OCI4.x. For a limitation in OCI1.0 (no xml export and max. 25 products) this version is not supported.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.extension.Extension

Extension.RestrictedLanguagesProvider, Extension.RightsProvider

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Manager

Manager.GenericManagerSingletonCreator, Manager.ManagerSingletonCreator

Field Summary

Fields inherited from class de.hybris.platform.oci.jalo.GeneratedOciManager

DEFAULT_INITIAL_ATTRIBUTES

Constructor Summary

Constructors

Constructor and Description
OciManager()

Method Summary

Modifier and Type	Method and Description
static String	createOciBuyerButton(SAPProductList sapproductlist) Generates a standard button (with a hidden formular) which submits this formular (here: the included xml data) to the SRM server.
static String	createOciBuyerButton(SAPProductList sapproductlist, boolean useHtml) Generates a standard button (with a hidden formular) which submits this formular (and the included xml or html data) to the SRM server.
static String	createOciBuyerButton(SAPProductList sapproductlist, String ociButton) Same as createOciBuyerButton(SAPProductList sapproductlist) but the html code for the button can be specified here. For the ociButton you can use a normal String to change only the label of the button or you can define your own input button in html code (for example you want an image button) The html code for an input button looks like <input type="submit" value="button label" id=submit1 name=submit1>
static String	createOciBuyerButton(SAPProductList sapproductlist, String ociButton, boolean useHtml) Same as createOciBuyerButton(SAPProductList, boolean) but the html code for the button and the exported format (XML/HTML) can be specified here. For the ociButton you can use a normal String to change only the label of the button or you can define your own input button in html code (for example you want an image button) The html code for an input button looks like <input type="submit" value="button label" id=submit1 name=submit1>
static OciManager	getInstance() Returns the instance of this manager.
boolean	isCreatorDisabled() This method returns true.
static boolean	isOciSession(JaloSession jaloSession) This method checks if the current jaloSession is an OciSession.
static void	ociLogin(HttpServletRequest request, HttpServletResponse response, CatalogLoginPerformer catalogLoginPerformer) Same as ociLogin(HttpServletRequest, HttpServletResponse, CatalogLoginPerformer, boolean, boolean ) but disableRedirect and useHtml is set to false as default. This method should be used as main entry point from the SRM server to the external catalog (your shop).
static void	ociLogin(HttpServletRequest request, HttpServletResponse response, CatalogLoginPerformer catalogLoginPerformer, boolean disableRedirect) This method calls ociLogin(HttpServletRequest, HttpServletResponse, CatalogLoginPerformer, boolean, boolean) with the last parameter set to false.
static void	ociLogin(HttpServletRequest request, HttpServletResponse response, CatalogLoginPerformer catalogLoginPerformer, boolean disableRedirect, boolean useHtml) This is the only method which will be called by the SRM server.

Methods inherited from class de.hybris.platform.oci.jalo.GeneratedOciManager

getDefaultAttributeModes, getName

Methods inherited from class de.hybris.platform.jalo.extension.Extension

checkBeforeItemRemoval, createEssentialData, createProjectData, createSampleData, getCreatorDescription, getCreatorName, getCreatorParameterDefault, getCreatorParameterNames, getCreatorParameterPossibleValues, getRemote, notifyInitializationEnd, notifyInitializationStart, notifyItemRemoval, onFirstSessionCreation, writeReplace

Methods inherited from class de.hybris.platform.jalo.Manager

afterItemCreation, beforeItemCreation, destroy, getAllValuesSessionContext, getAttribute, getAttributeMap, getFirstItemByAttribute, getFirstItemByAttribute, getRemoteManagerClass, getSession, getSingletonManagerInstance, getTenant, getTransientObject, getTransientObjectMap, init, setAttribute, setTenant, setTransientObject, unwrap, unwrap, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OciManager

public OciManager()

Method Detail

getInstance

public static OciManager getInstance()

Returns the instance of this manager.

Returns:

instance of this manager

isCreatorDisabled

public boolean isCreatorDisabled()

This method returns true.

Overrides:

isCreatorDisabled in class Extension

Returns:

true

createOciBuyerButton

public static String createOciBuyerButton(SAPProductList sapproductlist)
                                   throws OciException

Generates a standard button (with a hidden formular) which submits this formular (here: the included xml data) to the SRM server. The inserted button has the html code <input type="submit" value="SAP OCI Buyer" id=submit1 name=submit1> By default the data will be exported as XML data in the <form>. For export the data as html use createOciBuyerButton(SAPProductList, boolean) with last parameter set to true.

Parameters:

sapproductlist - the product list which has to be transfered to the SRM server

Returns:

html code, should be implemented in the cart

Throws:

OciException - throwed by problems

createOciBuyerButton

public static String createOciBuyerButton(SAPProductList sapproductlist,
                                          boolean useHtml)
                                   throws OciException

Generates a standard button (with a hidden formular) which submits this formular (and the included xml or html data) to the SRM server. The inserted button has the html code <input type="submit" value="SAP OCI Buyer" id=submit1 name=submit1>

Parameters:

sapproductlist - the product list which has to be transfered to the SRM server

useHtml - use true if the data should be exported as html code in the <form>, use false for export the data as XML in the <form>

Returns:

html code, should be implemented in the cart

Throws:

OciException - throwed by problems

createOciBuyerButton

public static String createOciBuyerButton(SAPProductList sapproductlist,
                                          String ociButton)
                                   throws OciException

Same as createOciBuyerButton(SAPProductList sapproductlist) but the html code for the button can be specified here.
For the ociButton you can use a normal String to change only the label of the button or you can define your own input button in html code (for example you want an image button)
The html code for an input button looks like <input type="submit" value="button label" id=submit1 name=submit1>

Parameters:

sapproductlist - the product list which has to be transfered to the SRM server

ociButton - your own html code for the button

Returns:

a html formular with your own button, should be implemented in the cart

Throws:

OciException - throwed by problems

createOciBuyerButton

public static String createOciBuyerButton(SAPProductList sapproductlist,
                                          String ociButton,
                                          boolean useHtml)
                                   throws OciException

Same as createOciBuyerButton(SAPProductList, boolean) but the html code for the button and the exported format (XML/HTML) can be specified here.
For the ociButton you can use a normal String to change only the label of the button or you can define your own input button in html code (for example you want an image button)
The html code for an input button looks like <input type="submit" value="button label" id=submit1 name=submit1>

Parameters:

useHtml - use true if the data should be exported as html code in the <form>, use false for export the data as XML in the <form>

sapproductlist - the product list which has to be transfered to the SRM server

ociButton - your own html code for the button

Returns:

a html formular with your own button, should be implemented in the cart

Throws:

OciException - throwed by problems

isOciSession

public static boolean isOciSession(JaloSession jaloSession)

This method checks if the current jaloSession is an OciSession.

Returns:

true if OciSession, false otherwise

ociLogin

public static void ociLogin(HttpServletRequest request,
                            HttpServletResponse response,
                            CatalogLoginPerformer catalogLoginPerformer)
                     throws Exception

Same as ociLogin(HttpServletRequest, HttpServletResponse, CatalogLoginPerformer, boolean, boolean ) but disableRedirect and useHtml is set to false as default.
This method should be used as main entry point from the SRM server to the external catalog (your shop).

Parameters:

request - contains information from the SRM server

response - the oci send the data to this response

catalogLoginPerformer - implemented interface for logging in into the external catalog

Throws:

Exception - throws OciExceptions or other exceptions

ociLogin

public static void ociLogin(HttpServletRequest request,
                            HttpServletResponse response,
                            CatalogLoginPerformer catalogLoginPerformer,
                            boolean disableRedirect)
                     throws Exception

This method calls ociLogin(HttpServletRequest, HttpServletResponse, CatalogLoginPerformer, boolean, boolean) with the last parameter set to false.

Parameters:

request - contains information from the SRM server

response - the oci send the data to this response

catalogLoginPerformer - implemented interface for logging in into the external catalog

disableRedirect - if set to true, all redirects (like CatalogLoginPerformer.getProductSearchURL() or CatalogLoginPerformer.getProductDetailURL() ) are disabled. Then you could implement your own logic for SRM field FUNCTION

Throws:

Exception - throws OciExceptions or other exceptions

ociLogin

public static void ociLogin(HttpServletRequest request,
                            HttpServletResponse response,
                            CatalogLoginPerformer catalogLoginPerformer,
                            boolean disableRedirect,
                            boolean useHtml)
                     throws Exception

This is the only method which will be called by the SRM server. It is technically the main method of the oci extension.

Parameters:

request - contains information from the SRM server

response - the oci send the data to this response

catalogLoginPerformer - implemented interface for logging in into the external catalog

disableRedirect - if set to true, all redirects (like CatalogLoginPerformer.getProductSearchURL() or CatalogLoginPerformer.getProductDetailURL() ) are disabled. Then you could implement your own logic for SRM field FUNCTION

useHtml - use true if the data should be exported as html code in the <form>, use false for export the data as XML in the <form>

Throws:

Exception - throws OciExceptions or other exceptions