• Home
• com.liferay
• com.liferay.object.rest.impl
• 1.0.165
• source code
• ObjectEntryOpenAPIResourceImpl.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.liferay.object.rest.internal.openapi.v1_0.ObjectEntryOpenAPIResourceImpl Maven / Gradle / Ivy

/**
 * SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
 * SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
 */

package com.liferay.object.rest.internal.openapi.v1_0;

import com.liferay.object.constants.ObjectFieldConstants;
import com.liferay.object.constants.ObjectFieldSettingConstants;
import com.liferay.object.constants.ObjectRelationshipConstants;
import com.liferay.object.field.setting.util.ObjectFieldSettingUtil;
import com.liferay.object.model.ObjectDefinition;
import com.liferay.object.model.ObjectField;
import com.liferay.object.model.ObjectRelationship;
import com.liferay.object.rest.dto.v1_0.FileEntry;
import com.liferay.object.rest.dto.v1_0.ListEntry;
import com.liferay.object.rest.internal.resource.v1_0.CollaboratorResourceImpl;
import com.liferay.object.rest.internal.resource.v1_0.ObjectEntryRelatedObjectsResourceImpl;
import com.liferay.object.rest.internal.resource.v1_0.ObjectEntryResourceImpl;
import com.liferay.object.rest.internal.resource.v1_0.OpenAPIResourceImpl;
import com.liferay.object.rest.internal.vulcan.openapi.contributor.ObjectEntryOpenAPIContributor;
import com.liferay.object.rest.openapi.v1_0.ObjectEntryOpenAPIResource;
import com.liferay.object.rest.openapi.v1_0.ObjectEntryOpenAPIResourceProvider;
import com.liferay.object.service.ObjectActionLocalService;
import com.liferay.object.service.ObjectDefinitionLocalService;
import com.liferay.object.service.ObjectFieldLocalService;
import com.liferay.object.service.ObjectRelationshipLocalService;
import com.liferay.object.system.SystemObjectDefinitionManagerRegistry;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.util.HashMapBuilder;
import com.liferay.portal.kernel.util.ListUtil;
import com.liferay.portal.kernel.util.MapUtil;
import com.liferay.portal.kernel.util.TreeMapBuilder;
import com.liferay.portal.vulcan.batch.engine.Field;
import com.liferay.portal.vulcan.dto.converter.DTOConverterRegistry;
import com.liferay.portal.vulcan.openapi.DTOProperty;
import com.liferay.portal.vulcan.openapi.OpenAPISchemaFilter;
import com.liferay.portal.vulcan.resource.OpenAPIResource;
import com.liferay.portal.vulcan.util.OpenAPIUtil;

import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.ArraySchema;
import io.swagger.v3.oas.models.media.Schema;

import jakarta.servlet.http.HttpServletRequest;

import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.UriInfo;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;

import org.osgi.framework.BundleContext;

/**
 * @author Luis Miguel Barcos
 */
public class ObjectEntryOpenAPIResourceImpl
	implements ObjectEntryOpenAPIResource {

	public ObjectEntryOpenAPIResourceImpl(
		BundleContext bundleContext, DTOConverterRegistry dtoConverterRegistry,
		ObjectActionLocalService objectActionLocalService,
		ObjectDefinition objectDefinition,
		ObjectDefinitionLocalService objectDefinitionLocalService,
		ObjectEntryOpenAPIResourceProvider objectEntryOpenAPIResourceProvider,
		ObjectFieldLocalService objectFieldLocalService,
		ObjectRelationshipLocalService objectRelationshipLocalService,
		OpenAPIResource openAPIResource,
		SystemObjectDefinitionManagerRegistry
			systemObjectDefinitionManagerRegistry) {

		_bundleContext = bundleContext;
		_dtoConverterRegistry = dtoConverterRegistry;
		_objectActionLocalService = objectActionLocalService;
		_objectDefinition = objectDefinition;
		_objectDefinitionLocalService = objectDefinitionLocalService;
		_objectEntryOpenAPIResourceProvider =
			objectEntryOpenAPIResourceProvider;
		_objectFieldLocalService = objectFieldLocalService;
		_objectRelationshipLocalService = objectRelationshipLocalService;
		_openAPIResource = openAPIResource;
		_systemObjectDefinitionManagerRegistry =
			systemObjectDefinitionManagerRegistry;
	}

	@Override
	public Map getFields(UriInfo uriInfo) throws Exception {
		DTOProperty objectEntryDTOProperty = _getObjectEntryDTOProperty(
			_objectDefinition);

		Response response = _getOpenAPI(
			true,
			_getOpenAPISchemaFilter(objectEntryDTOProperty, _objectDefinition),
			"json", uriInfo);

		Schema schema = _getObjectDefinitionSchema(
			(OpenAPI)response.getEntity());

		if (schema == null) {
			return Collections.emptyMap();
		}

		Map fields = new HashMap<>();

		Map relationshipNames = new HashMap<>();

		for (DTOProperty dtoProperty :
				objectEntryDTOProperty.getDTOProperties()) {

			if (!(dtoProperty instanceof RelationshipDTOProperty)) {
				continue;
			}

			RelationshipDTOProperty relationshipDTOProperty =
				(RelationshipDTOProperty)dtoProperty;

			relationshipNames.put(
				relationshipDTOProperty.getName(),
				relationshipDTOProperty.getRelationshipName());
		}

		List requiredPropertySchemaNames =
			_getRequiredPropertySchemaNames(schema);

		Map properties = schema.getProperties();

		for (Map.Entry schemaEntry : properties.entrySet()) {
			String propertyName = schemaEntry.getKey();
			Schema propertySchema = schemaEntry.getValue();

			fields.put(
				propertyName,
				Field.of(
					MapUtil.getString(relationshipNames, propertyName, null),
					propertySchema.getDescription(), propertyName,
					GetterUtil.getBoolean(propertySchema.getReadOnly()),
					_getRef(propertySchema),
					requiredPropertySchemaNames.contains(propertyName),
					propertySchema.getType(),
					OpenAPIUtil.getBatchUnsupportedFormats(
						propertySchema.getExtensions()),
					GetterUtil.getBoolean(propertySchema.getWriteOnly())));
		}

		return fields;
	}

	@Override
	public Response getOpenAPI(
			HttpServletRequest httpServletRequest, String type, UriInfo uriInfo)
		throws Exception {

		return _getOpenAPI(
			true,
			_getOpenAPISchemaFilter(
				_getObjectEntryDTOProperty(_objectDefinition),
				_objectDefinition),
			type, uriInfo);
	}

	@Override
	public Map getSchemas() throws Exception {
		Response response = _getOpenAPI(
			false,
			_getOpenAPISchemaFilter(
				_getObjectEntryDTOProperty(_objectDefinition),
				_objectDefinition),
			"json", null);

		OpenAPI openAPI = (OpenAPI)response.getEntity();

		Components components = openAPI.getComponents();

		return components.getSchemas();
	}

	private List _getDTOProperties(ObjectField objectField) {
		if (Objects.equals(
				objectField.getBusinessType(),
				ObjectFieldConstants.BUSINESS_TYPE_ATTACHMENT)) {

			DTOProperty dtoProperty = new DTOProperty(
				HashMapBuilder.put(
					"x-parent-map", "properties"
				).build(),
				objectField.getName(), FileEntry.class.getSimpleName());

			dtoProperty.setDTOProperties(
				Arrays.asList(
					new DTOProperty(
						Collections.singletonMap("x-parent-map", "properties"),
						"id", Long.class.getSimpleName()),
					new DTOProperty(
						Collections.singletonMap("x-parent-map", "properties"),
						"name", String.class.getSimpleName())));
			dtoProperty.setRequired(objectField.isRequired());

			return ListUtil.fromArray(dtoProperty);
		}
		else if (Objects.equals(
					objectField.getBusinessType(),
					ObjectFieldConstants.BUSINESS_TYPE_DATE) &&
				 _fieldNameMappings.containsKey(objectField.getName())) {

			return ListUtil.fromArray(
				new DTOProperty(
					null, _fieldNameMappings.get(objectField.getName()),
					ObjectFieldConstants.BUSINESS_TYPE_DATE_TIME) {

					{
						setRequired(objectField.isRequired());
					}
				});
		}
		else if (Objects.equals(
					objectField.getBusinessType(),
					ObjectFieldConstants.BUSINESS_TYPE_DATE_TIME)) {

			return ListUtil.fromArray(
				new DTOProperty(
					HashMapBuilder.put(
						"x-parent-map", "properties"
					).put(
						"x-timeStorage",
						ObjectFieldSettingUtil.getValue(
							ObjectFieldSettingConstants.NAME_TIME_STORAGE,
							objectField)
					).build(),
					objectField.getName(), objectField.getDBType()) {

					{
						setRequired(objectField.isRequired());
					}
				});
		}
		else if (Objects.equals(
					objectField.getBusinessType(),
					ObjectFieldConstants.BUSINESS_TYPE_ENCRYPTED) ||
				 Objects.equals(
					 objectField.getBusinessType(),
					 ObjectFieldConstants.BUSINESS_TYPE_LONG_TEXT) ||
				 Objects.equals(
					 objectField.getBusinessType(),
					 ObjectFieldConstants.BUSINESS_TYPE_RICH_TEXT)) {

			return ListUtil.fromArray(
				new DTOProperty(
					HashMapBuilder.put(
						"x-parent-map", "properties"
					).build(),
					objectField.getName(), "String") {

					{
						setRequired(objectField.isRequired());
					}
				});
		}
		else if (Objects.equals(
					objectField.getBusinessType(),
					ObjectFieldConstants.BUSINESS_TYPE_MULTISELECT_PICKLIST) ||
				 Objects.equals(
					 objectField.getBusinessType(),
					 ObjectFieldConstants.BUSINESS_TYPE_PICKLIST)) {

			DTOProperty dtoProperty = new DTOProperty(
				HashMapBuilder.put(
					"x-parent-map", "properties"
				).build(),
				objectField.getName(), ListEntry.class.getSimpleName());

			dtoProperty.setDTOProperties(
				Arrays.asList(
					new DTOProperty(
						Collections.singletonMap("x-parent-map", "properties"),
						"key", String.class.getSimpleName()),
					new DTOProperty(
						Collections.singletonMap("x-parent-map", "properties"),
						"name", String.class.getSimpleName())));
			dtoProperty.setRequired(objectField.isRequired());

			return ListUtil.fromArray(dtoProperty);
		}
		else if (Objects.equals(
					objectField.getBusinessType(),
					ObjectFieldConstants.BUSINESS_TYPE_PRECISION_DECIMAL)) {

			return ListUtil.fromArray(
				new DTOProperty(
					Collections.singletonMap("x-parent-map", "properties"),
					objectField.getName(), Double.class.getSimpleName()) {

					{
						setRequired(objectField.isRequired());
					}
				});
		}
		else if (Objects.equals(
					objectField.getBusinessType(),
					ObjectFieldConstants.BUSINESS_TYPE_RELATIONSHIP) &&
				 Objects.equals(
					 objectField.getRelationshipType(),
					 ObjectRelationshipConstants.TYPE_ONE_TO_MANY)) {

			ObjectRelationship objectRelationship =
				_objectRelationshipLocalService.
					fetchObjectRelationshipByObjectFieldId2(
						objectField.getObjectFieldId());

			String relationshipName = objectRelationship.getName();

			return Arrays.asList(
				new RelationshipDTOProperty(
					HashMapBuilder.put(
						"x-parent-map", "properties"
					).build(),
					objectField.getName(), relationshipName,
					objectField.getDBType()) {

					{
						setRequired(objectField.isRequired());
					}
				},
				new RelationshipDTOProperty(
					HashMapBuilder.put(
						"x-parent-map", "properties"
					).build(),
					relationshipName, relationshipName,
					String.class.getSimpleName()) {

					{
						setRequired(objectField.isRequired());
					}
				},
				new RelationshipDTOProperty(
					HashMapBuilder.put(
						"x-parent-map", "properties"
					).build(),
					ObjectFieldSettingUtil.getValue(
						ObjectFieldSettingConstants.
							NAME_OBJECT_RELATIONSHIP_ERC_OBJECT_FIELD_NAME,
						objectField),
					relationshipName, String.class.getSimpleName()) {

					{
						setRequired(objectField.isRequired());
					}
				},
				new RelationshipDTOProperty(
					Collections.singletonMap("x-parent-map", "properties"),
					relationshipName + "ERC", relationshipName,
					String.class.getSimpleName()) {

					{
						setReadOnly(true);
					}
				});
		}

		return ListUtil.fromArray(
			new DTOProperty(
				HashMapBuilder.put(
					"x-parent-map", "properties"
				).build(),
				objectField.getName(), objectField.getDBType()) {

				{
					setRequired(objectField.isRequired());
				}
			});
	}

	private Schema _getObjectDefinitionSchema(OpenAPI openAPI) {
		Components components = openAPI.getComponents();

		Map schemas = components.getSchemas();

		return schemas.get(_objectDefinition.getShortName());
	}

	private DTOProperty _getObjectEntryDTOProperty(
		ObjectDefinition objectDefinition) {

		DTOProperty dtoProperty = new DTOProperty(
			new HashMap<>(), "ObjectEntry", "Object");

		List dtoProperties = new ArrayList<>();

		for (ObjectField objectField :
				_objectFieldLocalService.getObjectFields(
					objectDefinition.getObjectDefinitionId())) {

			dtoProperties.addAll(_getDTOProperties(objectField));

			if (objectField.isLocalized()) {
				dtoProperties.add(
					new DTOProperty(
						Collections.singletonMap("x-parent-map", "properties"),
						objectField.getI18nObjectFieldName(),
						Map.class.getSimpleName()) {

						{
							setRequired(objectField.isRequired());
						}
					});
			}
		}

		dtoProperty.setDTOProperties(dtoProperties);

		return dtoProperty;
	}

	private Response _getOpenAPI(
			boolean addRelatedSchemas, OpenAPISchemaFilter openAPISchemaFilter,
			String type, UriInfo uriInfo)
		throws Exception {

		return _openAPIResource.getOpenAPI(
			new ObjectEntryOpenAPIContributor(
				addRelatedSchemas, _bundleContext, _dtoConverterRegistry,
				_objectActionLocalService, _objectDefinition,
				_objectEntryOpenAPIResourceProvider, _objectFieldLocalService,
				_objectRelationshipLocalService, _openAPIResource,
				_systemObjectDefinitionManagerRegistry),
			openAPISchemaFilter,
			new HashSet>() {
				{
					add(CollaboratorResourceImpl.class);
					add(ObjectEntryRelatedObjectsResourceImpl.class);
					add(ObjectEntryResourceImpl.class);
					add(OpenAPIResourceImpl.class);
				}
			},
			type, uriInfo);
	}

	private OpenAPISchemaFilter _getOpenAPISchemaFilter(
		DTOProperty dtoProperty, ObjectDefinition objectDefinition) {

		OpenAPISchemaFilter openAPISchemaFilter = new OpenAPISchemaFilter();

		openAPISchemaFilter.setApplicationPath(
			objectDefinition.getRESTContextPath());

		DTOProperty pageDTOProperty = new DTOProperty(
			new HashMap<>(), "PageObject", "Object");

		pageDTOProperty.setDTOProperties(
			Arrays.asList(
				new DTOProperty(new HashMap<>(), "items", "Array") {
					{
						setDTOProperties(
							Arrays.asList(
								new DTOProperty(
									new HashMap<>(), "ObjectEntry", "Object")));
					}
				}));

		openAPISchemaFilter.setDTOProperties(
			Arrays.asList(dtoProperty, pageDTOProperty));

		openAPISchemaFilter.setSchemaMappings(
			TreeMapBuilder.create(
				Collections.reverseOrder()
			).put(
				"ObjectEntry", objectDefinition.getShortName()
			).put(
				"PageObject", "Page" + objectDefinition.getShortName()
			).put(
				"PageObjectEntry", "Page" + objectDefinition.getShortName()
			).build());

		return openAPISchemaFilter;
	}

	private String _getRef(Schema schema) {
		if (schema instanceof ArraySchema) {
			ArraySchema arraySchema = (ArraySchema)schema;

			Schema itemsSchema = arraySchema.getItems();

			return itemsSchema.get$ref();
		}

		return schema.get$ref();
	}

	private List _getRequiredPropertySchemaNames(Schema schema) {
		List requiredPropertySchemaNames = schema.getRequired();

		if (requiredPropertySchemaNames == null) {
			requiredPropertySchemaNames = Collections.emptyList();
		}

		return requiredPropertySchemaNames;
	}

	private final BundleContext _bundleContext;
	private final DTOConverterRegistry _dtoConverterRegistry;
	private final Map _fieldNameMappings = HashMapBuilder.put(
		"createDate", "dateCreated"
	).put(
		"modifiedDate", "dateModified"
	).build();
	private final ObjectActionLocalService _objectActionLocalService;
	private final ObjectDefinition _objectDefinition;
	private final ObjectDefinitionLocalService _objectDefinitionLocalService;
	private final ObjectEntryOpenAPIResourceProvider
		_objectEntryOpenAPIResourceProvider;
	private final ObjectFieldLocalService _objectFieldLocalService;
	private final ObjectRelationshipLocalService
		_objectRelationshipLocalService;
	private final OpenAPIResource _openAPIResource;
	private final SystemObjectDefinitionManagerRegistry
		_systemObjectDefinitionManagerRegistry;

	private class RelationshipDTOProperty extends DTOProperty {

		public RelationshipDTOProperty(
			Map extensions, String name,
			String relationshipName, String type) {

			super(extensions, name, type);

			_relationshipName = relationshipName;
		}

		public String getRelationshipName() {
			return _relationshipName;
		}

		private final String _relationshipName;

	}

}