OX as a Service Provisioning using SOAP - Revision history

Choeger: /* Generating the SOAP client */

2023-03-02T12:18:35Z

Generating the SOAP client

← Older revision		Revision as of 12:18, 2 March 2023
Line 611:		Line 611:

	==== Generating the SOAP client ====		==== Generating the SOAP client ====

			'''Note that the below instructions only work with Java version 8 and no later version'''

	Since Open-Xchange is using [http://cxf.apache.org/ Apache CXF] for SOAP, we recommend to use the <tt>wsdl2java</tt>		Since Open-Xchange is using [http://cxf.apache.org/ Apache CXF] for SOAP, we recommend to use the <tt>wsdl2java</tt>

Choeger at 13:54, 7 February 2023

2023-02-07T13:54:45Z

← Older revision		Revision as of 13:54, 7 February 2023
Line 230:		Line 230:
	==== Subadmin credentials ====		==== Subadmin credentials ====

	The first requirement is to get subadmin credentials for your company~~. Please follow the steps~~		The first requirement is to get subadmin credentials for your company.
	~~[[OX_as_a_Service_Guide#How_to_become_a_customer.3F\|documented here]] to get such an account~~.

	Together with the login and password you will also retrieve the provisioning URL to be used by		Together with the login and password you will also retrieve the provisioning URL to be used by

Choeger at 13:53, 7 February 2023

2023-02-07T13:53:18Z

← Older revision		Revision as of 13:53, 7 February 2023
Line 1:		Line 1:
	= Tutorial: Provision OX as a Service using SOAP =		= Tutorial: Provision OX as a Service using SOAP =

	~~== Overview ==~~

	~~[[OX_as_a_Service_Guide\|OX as a Service]] is using the same code everybody can download and install using our~~
	~~various guides. Since it is a hosted service using a reseller model, the provisioning api is using the [[Reseller_Bundle\|Reseller Bundle]]~~
	~~to extend the usual two administrative layers by an additional one.~~

	~~Open-Xchange does also not contain a mail server in general, but requires one in order to act like a mail client. OX as a Service~~
	~~is using [https://www.open-xchange.com/portfolio/ox-dovecot-pro/ OX Dovecot Pro] as mail server and thus extends the usual Open-Xchange provisioning capabilities by mechanisms~~
	~~to manage some email specific settings.~~

	== Open-Xchange concept of Contexts ==		== Open-Xchange concept of Contexts ==

Choeger: /* User creation */

2021-06-15T12:39:37Z

User creation

← Older revision		Revision as of 12:39, 15 June 2021
Line 1,012:		Line 1,012:

	final long unifiedQuotaMax = 1000l;		final long unifiedQuotaMax = 1000l;

	final String userEmail = "auser@example.com";		final String userEmail = "auser@example.com";
	auser.setName("auser");		auser.setName("auser");
Line 1,027:		Line 1,027:

	// enable unified quota (might be enabled globally, already, though)		// enable unified quota (might be enabled globally, already, though)
	~~final SOAPMapEntry config = new SOAPMapEntry();~~
	~~config.setKey("config");~~
	~~final SOAPStringMap configEntries = new SOAPStringMap();~~
	final Entry unifiedQuota = new Entry();		final Entry unifiedQuota = new Entry();
	unifiedQuota.setKey("com.openexchange.unifiedquota.enabled");		unifiedQuota.setKey("com.openexchange.unifiedquota.enabled");
	unifiedQuota.setValue("true");		unifiedQuota.setValue("true");

			final SOAPStringMap configEntries = new SOAPStringMap();
	configEntries.getEntries().add(unifiedQuota);		configEntries.getEntries().add(unifiedQuota);

			final SOAPMapEntry config = new SOAPMapEntry();
			config.setKey("config");
			config.setValue(configEntries);

	final SOAPStringMapMap userattrs = new SOAPStringMapMap();		final SOAPStringMapMap userattrs = new SOAPStringMapMap();
	userattrs.getEntries().add(config);		userattrs.getEntries().add(config);

Choeger: /* User creation */

2021-06-15T09:16:07Z

User creation

← Older revision		Revision as of 09:16, 15 June 2021
Line 941:		Line 941:

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">

	package com.openexchange.oxaas.myclient;		package com.openexchange.oxaas.myclient;

Line 964:		Line 965:
	import com.openexchange.oxaas.user.reseller.soap.dataobjects.ResellerContext;		import com.openexchange.oxaas.user.reseller.soap.dataobjects.ResellerContext;
	import com.openexchange.oxaas.user.rmi.dataobjects.Credentials;		import com.openexchange.oxaas.user.rmi.dataobjects.Credentials;
			import com.openexchange.oxaas.user.soap.dataobjects.Entry;
			import com.openexchange.oxaas.user.soap.dataobjects.SOAPMapEntry;
			import com.openexchange.oxaas.user.soap.dataobjects.SOAPStringMap;
			import com.openexchange.oxaas.user.soap.dataobjects.SOAPStringMapMap;
	import com.openexchange.oxaas.user.soap.dataobjects.User;		import com.openexchange.oxaas.user.soap.dataobjects.User;


	/*		/*
Line 975:		Line 979:
	public class MyUserClientExample {		public class MyUserClientExample {

	private static final QName USER_SERVICE_NAME = new QName("http://soap.reseller.admin.openexchange.com", "OXResellerUserService");		private static final QName USER_SERVICE_NAME = new QName("http://soap.reseller.admin.openexchange.com", "OXResellerUserService");
	private static final QName CONTEXT_SERVICE_NAME = new QName("http://soap.reseller.admin.openexchange.com", "OXResellerContextService");		private static final QName CONTEXT_SERVICE_NAME = new QName("http://soap.reseller.admin.openexchange.com", "OXResellerContextService");
	private static final QName OXAAS_SERVICE_NAME = new QName("http://soap.oxaas.admin.openexchange.com/", "OXaaSService");		private static final QName OXAAS_SERVICE_NAME = new QName("http://soap.oxaas.admin.openexchange.com/", "OXaaSService");

	public static void main(String[] args) {		public static void main(String[] args) {
	final String subadminname = "mysubadmin";		final String subadminname = "mysubadmin";
	final String subadminpw = "secret";		final String subadminpw = "secret";
	final String ctxadmname = "oxadmin";		final String ctxadmname = "oxadmin";
	final String ctxadmpw = "secret";		final String ctxadmpw = "secret";
	final String ctxname = subadminname + "_myctx";		final String ctxname = subadminname + "_myctx";

	Credentials creds = new Credentials();		Credentials creds = new Credentials();
	ResellerContext ctx = new ResellerContext();		ResellerContext ctx = new ResellerContext();
Line 995:		Line 999:
	OXResellerContextServicePortType contextport = contextservice.getOXResellerContextServiceHttpSoap11Endpoint();		OXResellerContextServicePortType contextport = contextservice.getOXResellerContextServiceHttpSoap11Endpoint();
	OXaaSService_Service oxaasservice = new OXaaSService_Service(OXaaSService_Service.WSDL_LOCATION, OXAAS_SERVICE_NAME);		OXaaSService_Service oxaasservice = new OXaaSService_Service(OXaaSService_Service.WSDL_LOCATION, OXAAS_SERVICE_NAME);
	OXaaSService oxaasport = oxaasservice.getOXaaSServiceSOAP();		OXaaSService oxaasport = oxaasservice.getOXaaSServiceSOAP();


	// We need to use the ResellerContextService SOAP client stub to retrieve the context id		// We need to use the ResellerContextService SOAP client stub to retrieve the context id
	com.openexchange.oxaas.context.rmi.dataobjects.Credentials ctxCreds = new com.openexchange.oxaas.context.rmi.dataobjects.Credentials();		com.openexchange.oxaas.context.rmi.dataobjects.Credentials ctxCreds = new com.openexchange.oxaas.context.rmi.dataobjects.Credentials();
Line 1,008:		Line 1,011:
	creds.setPassword(ctxadmpw);		creds.setPassword(ctxadmpw);

			final long unifiedQuotaMax = 1000l;

	final String userEmail = "auser@example.com";		final String userEmail = "auser@example.com";
	auser.setName("auser");		auser.setName("auser");
Line 1,019:		Line 1,024:
	auser.setLanguage("en_US");		auser.setLanguage("en_US");
	auser.setTimezone("Europe/Berlin");		auser.setTimezone("Europe/Berlin");
			auser.setMaxQuota(unifiedQuotaMax);

			// enable unified quota (might be enabled globally, already, though)
			final SOAPMapEntry config = new SOAPMapEntry();
			config.setKey("config");
			final SOAPStringMap configEntries = new SOAPStringMap();
			final Entry unifiedQuota = new Entry();
			unifiedQuota.setKey("com.openexchange.unifiedquota.enabled");
			unifiedQuota.setValue("true");
			configEntries.getEntries().add(unifiedQuota);
			final SOAPStringMapMap userattrs = new SOAPStringMapMap();
			userattrs.getEntries().add(config);
			auser.setUserAttributes(userattrs);

	try {		try {
Line 1,028:		Line 1,046:
	User ret = userport.createByModuleAccessName(ctx, auser, "groupware_premium", creds);		User ret = userport.createByModuleAccessName(ctx, auser, "groupware_premium", creds);
	System.out.println("created user with id=" + ret.getId());		System.out.println("created user with id=" + ret.getId());

	// set mail quota for that user using OXaaSService		// set mail quota for that user using OXaaSService
	com.openexchange.oxaas.extra.Credentials oxaasCtxCreds = new com.openexchange.oxaas.extra.Credentials();		com.openexchange.oxaas.extra.Credentials oxaasCtxCreds = new com.openexchange.oxaas.extra.Credentials();
	oxaasCtxCreds.setLogin(ctxadmname);		oxaasCtxCreds.setLogin(ctxadmname);
	oxaasCtxCreds.setPassword(ctxadmpw);		oxaasCtxCreds.setPassword(ctxadmpw);
	oxaasport.setMailQuota(ctxRet.getId(), ret.getId(), ~~1000l~~, oxaasCtxCreds);		oxaasport.setMailQuota(ctxRet.getId(), ret.getId(), unifiedQuotaMax, oxaasCtxCreds);

	// check whether the login for the user has been created within my subadmin namespace		// check whether the login for the user has been created within my subadmin namespace
	// NOTE: this check should be used beforehand usually: check whether login exists and then create it if not		// NOTE: this check should be used beforehand usually: check whether login exists and then create it if not
Line 1,040:		Line 1,058:
	oxaasAdminCreds.setLogin(subadminname);		oxaasAdminCreds.setLogin(subadminname);
	oxaasAdminCreds.setPassword(subadminpw);		oxaasAdminCreds.setPassword(subadminpw);
	if( oxaasport.existsLogin("auser", oxaasAdminCreds) ) {		if (oxaasport.existsLogin("auser", oxaasAdminCreds)) {
	System.out.println("all ok, user login has been created");		System.out.println("all ok, user login has been created");
	}		}

	System.in.read();		System.in.read();

	System.out.println("deleting created user again");		System.out.println("deleting created user again");
	Delete del = new Delete();		Delete del = new Delete();

Choeger: /* Create a context */

2020-04-21T11:07:12Z

Create a context

← Older revision		Revision as of 11:07, 21 April 2020
Line 290:		Line 290:
	; linkColor: io.ox/dynamic-theme//linkColor		; linkColor: io.ox/dynamic-theme//linkColor
	; for further theme parameters, check https://documentation.open-xchange.com/latest/ui/theming/dynamic-theming.html		; for further theme parameters, check https://documentation.open-xchange.com/latest/ui/theming/dynamic-theming.html
			; about dialogue: com.openexchange.appsuite.servercontact, see below

	; id: A numerical id bound to the context. When you create a context, this id will be generated. You will need that later when you manage users. The id can be looked up via the context name.		; id: A numerical id bound to the context. When you create a context, this id will be generated. You will need that later when you manage users. The id can be looked up via the context name.

Choeger: /* userAttributes */

2020-04-21T10:56:58Z

userAttributes

← Older revision		Revision as of 10:56, 21 April 2020
Line 353:		Line 353:
	'value' => 'true',		'value' => 'true',
	'key' => 'com.openexchange.capability.dynamic-theme'		'key' => 'com.openexchange.capability.dynamic-theme'
			},
			{
			'value' => 'My Example Org \| <a href=\\"https://www.example.org\\" target=\\"_blank\\">www.example.org</a> \| <a href=\\"https://example.org/help\\" target=\\"_blank\\">Contact us</a>',
			'key' => 'com.openexchange.appsuite.servercontact'
	} ]		} ]
	},		},

WolfgangRosenauer at 11:26, 4 February 2020

2020-02-04T11:26:53Z

← Older revision		Revision as of 11:26, 4 February 2020
Line 563:		Line 563:
	! Pro		! Pro
	\| <tt>groupware_premium</tt>		\| <tt>groupware_premium</tt>
	\| <tt>com.openexchange.capability.drive = '''true'''</tt><br><tt>com.openexchange.capability.document_preview = '''true'''</tt><br><tt>com.openexchange.capability.spreadsheet = '''true'''</tt><br><tt>com.openexchange.capability.text = '''true'''</tt><br><tt>com.openexchange.capability.presenter = '''true'''</tt><br><tt>com.openexchange.capability.remote_presenter = '''true'''</tt><br><tt>com.openexchange.capability.guard = ~~'''~~true~~'''~~</tt><br><tt>com.openexchange.capability.guard-mail = ~~'''~~true~~'''~~</tt><br><tt>com.openexchange.capability.guard-drive = ~~'''~~true~~'''~~</tt>		\| <tt>com.openexchange.capability.drive = '''true'''</tt><br><tt>com.openexchange.capability.document_preview = '''true'''</tt><br><tt>com.openexchange.capability.spreadsheet = '''true'''</tt><br><tt>com.openexchange.capability.text = '''true'''</tt><br><tt>com.openexchange.capability.presenter = '''true'''</tt><br><tt>com.openexchange.capability.remote_presenter = '''true'''</tt><br><tt>com.openexchange.capability.guard = true/false</tt><br><tt>com.openexchange.capability.guard-mail = true/false</tt><br><tt>com.openexchange.capability.guard-drive = true/false</tt>
	\|}		\|}

Choeger: /* SSL-related hints */

2019-10-17T11:34:53Z

SSL-related hints

← Older revision		Revision as of 11:34, 17 October 2019
Line 752:		Line 752:

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	OXResellerContextServicePortType contextport =		OXResellerContextServicePortType contextport = contextservice.getOXResellerContextServiceHttpSoap11Endpoint();
	contextservice.getOXResellerContextServiceHttpSoap11Endpoint();
	</syntaxhighlight>		</syntaxhighlight>

Line 759:		Line 758:

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	// insert in your imports section:		// insert in your imports section:
	// import javax.xml.ws.BindingProvider;		// import javax.xml.ws.BindingProvider;
	((BindingProvider)contextport).getRequestContext().put(		((BindingProvider)contextport).getRequestContext().put(
	BindingProvider.ENDPOINT_ADDRESS_PROPERTY,		BindingProvider.ENDPOINT_ADDRESS_PROPERTY,
	((String)((BindingProvider)contextport).getRequestContext()		((String)((BindingProvider)contextport).getRequestContext()
	.get(BindingProvider.ENDPOINT_ADDRESS_PROPERTY))		.get(BindingProvider.ENDPOINT_ADDRESS_PROPERTY))
	.replaceAll("^http:", "https:"));		.replaceAll("^http:", "https:"));
	</syntaxhighlight>		</syntaxhighlight>

Choeger: /* Overview */

2019-10-17T11:29:00Z

Overview

← Older revision		Revision as of 11:29, 17 October 2019
Line 8:		Line 8:

	Open-Xchange does also not contain a mail server in general, but requires one in order to act like a mail client. OX as a Service		Open-Xchange does also not contain a mail server in general, but requires one in order to act like a mail client. OX as a Service
	is using [~~http~~://dovecot~~.org~~ Dovecot] as mail server and thus extends the usual Open-Xchange provisioning capabilities by mechanisms		is using [https://www.open-xchange.com/portfolio/ox-dovecot-pro/ OX Dovecot Pro] as mail server and thus extends the usual Open-Xchange provisioning capabilities by mechanisms
	to manage some email specific settings.		to manage some email specific settings.