forked from community/device-mgt-core
commit
95fec070aa
@ -0,0 +1,324 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.jaxrs.service.api;
|
||||
import io.swagger.annotations.Api;
|
||||
import io.swagger.annotations.ApiOperation;
|
||||
import io.swagger.annotations.ApiResponse;
|
||||
import io.swagger.annotations.ApiResponses;
|
||||
import io.swagger.annotations.Extension;
|
||||
import io.swagger.annotations.ExtensionProperty;
|
||||
import io.swagger.annotations.Info;
|
||||
import io.swagger.annotations.ResponseHeader;
|
||||
import io.swagger.annotations.SwaggerDefinition;
|
||||
import io.swagger.annotations.Tag;
|
||||
import io.swagger.annotations.ApiParam;
|
||||
import org.apache.axis2.transport.http.HTTPConstants;
|
||||
import org.wso2.carbon.apimgt.annotations.api.Scope;
|
||||
import org.wso2.carbon.apimgt.annotations.api.Scopes;
|
||||
import org.wso2.carbon.device.mgt.common.metadata.mgt.Metadata;
|
||||
import org.wso2.carbon.device.mgt.common.metadata.mgt.WhiteLabelThemeCreateRequest;
|
||||
import org.wso2.carbon.device.mgt.jaxrs.beans.ErrorResponse;
|
||||
import org.wso2.carbon.device.mgt.jaxrs.util.Constants;
|
||||
import javax.ws.rs.Consumes;
|
||||
import javax.ws.rs.GET;
|
||||
import javax.ws.rs.PUT;
|
||||
import javax.ws.rs.Path;
|
||||
import javax.ws.rs.Produces;
|
||||
import javax.ws.rs.PathParam;
|
||||
import javax.ws.rs.core.MediaType;
|
||||
import javax.ws.rs.core.Response;
|
||||
|
||||
/**
|
||||
* Metadata related REST-API implementation.
|
||||
*/
|
||||
@SwaggerDefinition(
|
||||
info = @Info(
|
||||
version = "1.0.0",
|
||||
title = "Whitelabel Service",
|
||||
extensions = {
|
||||
@Extension(properties = {
|
||||
@ExtensionProperty(name = "name", value = "WhiteLabelManagement"),
|
||||
@ExtensionProperty(name = "context", value = "/api/device-mgt/v1.0/whitelabel"),
|
||||
})
|
||||
}
|
||||
),
|
||||
tags = {
|
||||
@Tag(name = "device_management")
|
||||
}
|
||||
)
|
||||
@Scopes(
|
||||
scopes = {
|
||||
@Scope(
|
||||
name = "View Whitelabel",
|
||||
description = "View whitelabel details",
|
||||
key = "perm:whitelabel:view",
|
||||
roles = {"Internal/devicemgt-user"},
|
||||
permissions = {"/device-mgt/whitelabel/view"}
|
||||
),
|
||||
@Scope(
|
||||
name = "Update Whitelabel",
|
||||
description = "Updating whitelabel",
|
||||
key = "perm:whitelabel:update",
|
||||
roles = {"Internal/devicemgt-user"},
|
||||
permissions = {"/device-mgt/whitelabel/update"}
|
||||
),
|
||||
}
|
||||
)
|
||||
@Api(value = "Whitelabel Management")
|
||||
@Path("/whitelabel")
|
||||
@Produces(MediaType.APPLICATION_JSON)
|
||||
@Consumes(MediaType.APPLICATION_JSON)
|
||||
public interface WhiteLabelService {
|
||||
|
||||
@GET
|
||||
@Path("/{tenantDomain}/favicon")
|
||||
@ApiOperation(
|
||||
httpMethod = HTTPConstants.HEADER_GET,
|
||||
value = "Get whitelabel favicon",
|
||||
notes = "Get whitelabel favicon for the tenant of the logged in user",
|
||||
tags = "Tenant Metadata Management"
|
||||
)
|
||||
@ApiResponses(
|
||||
value = {
|
||||
@ApiResponse(
|
||||
code = 200,
|
||||
message = "OK. \n Successfully retrieved white label favicon.",
|
||||
responseHeaders = {
|
||||
@ResponseHeader(
|
||||
name = "Content-Type",
|
||||
description = "The content type of the body"),
|
||||
@ResponseHeader(
|
||||
name = "ETag",
|
||||
description = "Entity Tag of the response resource.\n" +
|
||||
"Used by caches, or in conditional requests."),
|
||||
@ResponseHeader(
|
||||
name = "Last-Modified",
|
||||
description = "Date and time the resource was last modified.\n" +
|
||||
"Used by caches, or in conditional requests."),
|
||||
}),
|
||||
@ApiResponse(
|
||||
code = 500,
|
||||
message = "Internal Server Error. " +
|
||||
"\n Server error occurred while getting white label artifact.",
|
||||
response = ErrorResponse.class)
|
||||
})
|
||||
Response getWhiteLabelFavicon( @ApiParam(
|
||||
name = "tenantDomain",
|
||||
value = "The tenant domain.",
|
||||
required = true) @PathParam("tenantDomain") String tenantDomain);
|
||||
|
||||
@GET
|
||||
@Path("/{tenantDomain}/logo")
|
||||
@ApiOperation(
|
||||
httpMethod = HTTPConstants.HEADER_GET,
|
||||
value = "Get whitelabel logo",
|
||||
notes = "Get whitelabel logo for the tenant of the logged in user",
|
||||
tags = "Tenant Metadata Management"
|
||||
)
|
||||
@ApiResponses(
|
||||
value = {
|
||||
@ApiResponse(
|
||||
code = 200,
|
||||
message = "OK. \n Successfully retrieved white label logo.",
|
||||
response = Metadata.class,
|
||||
responseHeaders = {
|
||||
@ResponseHeader(
|
||||
name = "Content-Type",
|
||||
description = "The content type of the body"),
|
||||
@ResponseHeader(
|
||||
name = "ETag",
|
||||
description = "Entity Tag of the response resource.\n" +
|
||||
"Used by caches, or in conditional requests."),
|
||||
@ResponseHeader(
|
||||
name = "Last-Modified",
|
||||
description = "Date and time the resource was last modified.\n" +
|
||||
"Used by caches, or in conditional requests."),
|
||||
}),
|
||||
@ApiResponse(
|
||||
code = 500,
|
||||
message = "Internal Server Error. " +
|
||||
"\n Server error occurred while getting white label artifact.",
|
||||
response = ErrorResponse.class)
|
||||
})
|
||||
Response getWhiteLabelLogo(
|
||||
@ApiParam(
|
||||
name = "tenantDomain",
|
||||
value = "The tenant domain.",
|
||||
required = true)
|
||||
@PathParam("tenantDomain") String tenantDomain);
|
||||
|
||||
@GET
|
||||
@Path("/{tenantDomain}/icon")
|
||||
@ApiOperation(
|
||||
httpMethod = HTTPConstants.HEADER_GET,
|
||||
value = "Get whitelabel logo icon",
|
||||
notes = "Get whitelabel logo icon for the tenant of the logged in user",
|
||||
tags = "Tenant Metadata Management"
|
||||
)
|
||||
@ApiResponses(
|
||||
value = {
|
||||
@ApiResponse(
|
||||
code = 200,
|
||||
message = "OK. \n Successfully retrieved white label logo.",
|
||||
response = Metadata.class,
|
||||
responseHeaders = {
|
||||
@ResponseHeader(
|
||||
name = "Content-Type",
|
||||
description = "The content type of the body"),
|
||||
@ResponseHeader(
|
||||
name = "ETag",
|
||||
description = "Entity Tag of the response resource.\n" +
|
||||
"Used by caches, or in conditional requests."),
|
||||
@ResponseHeader(
|
||||
name = "Last-Modified",
|
||||
description = "Date and time the resource was last modified.\n" +
|
||||
"Used by caches, or in conditional requests."),
|
||||
}),
|
||||
@ApiResponse(
|
||||
code = 500,
|
||||
message = "Internal Server Error. " +
|
||||
"\n Server error occurred while getting white label artifact.",
|
||||
response = ErrorResponse.class)
|
||||
})
|
||||
Response getWhiteLabelLogoIcon( @ApiParam(
|
||||
name = "tenantDomain",
|
||||
value = "The tenant domain.",
|
||||
required = true) @PathParam("tenantDomain") String tenantDomain);
|
||||
|
||||
@PUT
|
||||
@ApiOperation(
|
||||
produces = MediaType.APPLICATION_JSON,
|
||||
httpMethod = HTTPConstants.HEADER_POST,
|
||||
value = "Create whitelabel for tenant",
|
||||
notes = "Create whitelabel for the tenant of the logged in user",
|
||||
tags = "Tenant Metadata Management",
|
||||
extensions = {
|
||||
@Extension(properties = {
|
||||
@ExtensionProperty(name = Constants.SCOPE, value = "perm:whitelabel:update")
|
||||
})
|
||||
}
|
||||
)
|
||||
@ApiResponses(
|
||||
value = {
|
||||
@ApiResponse(
|
||||
code = 200,
|
||||
message = "OK. \n Successfully created white label theme.",
|
||||
response = Metadata.class,
|
||||
responseHeaders = {
|
||||
@ResponseHeader(
|
||||
name = "Content-Type",
|
||||
description = "The content type of the body"),
|
||||
@ResponseHeader(
|
||||
name = "ETag",
|
||||
description = "Entity Tag of the response resource.\n" +
|
||||
"Used by caches, or in conditional requests."),
|
||||
@ResponseHeader(
|
||||
name = "Last-Modified",
|
||||
description = "Date and time the resource was last modified.\n" +
|
||||
"Used by caches, or in conditional requests."),
|
||||
}),
|
||||
@ApiResponse(
|
||||
code = 500,
|
||||
message = "Internal Server Error. " +
|
||||
"\n Server error occurred while creating white label theme.",
|
||||
response = ErrorResponse.class)
|
||||
})
|
||||
Response updateWhiteLabelTheme(WhiteLabelThemeCreateRequest whiteLabelThemeCreateRequest);
|
||||
|
||||
@GET
|
||||
@ApiOperation(
|
||||
produces = MediaType.APPLICATION_JSON,
|
||||
httpMethod = HTTPConstants.HEADER_POST,
|
||||
value = "Get whitelabel for tenant",
|
||||
notes = "Get whitelabel for the tenant of the logged in user",
|
||||
tags = "Tenant Metadata Management",
|
||||
extensions = {
|
||||
@Extension(properties = {
|
||||
@ExtensionProperty(name = Constants.SCOPE, value = "perm:whitelabel:view")
|
||||
})
|
||||
}
|
||||
)
|
||||
@ApiResponses(
|
||||
value = {
|
||||
@ApiResponse(
|
||||
code = 200,
|
||||
message = "OK. \n Successfully fetched white label theme.",
|
||||
response = Metadata.class,
|
||||
responseHeaders = {
|
||||
@ResponseHeader(
|
||||
name = "Content-Type",
|
||||
description = "The content type of the body"),
|
||||
@ResponseHeader(
|
||||
name = "ETag",
|
||||
description = "Entity Tag of the response resource.\n" +
|
||||
"Used by caches, or in conditional requests."),
|
||||
@ResponseHeader(
|
||||
name = "Last-Modified",
|
||||
description = "Date and time the resource was last modified.\n" +
|
||||
"Used by caches, or in conditional requests."),
|
||||
}),
|
||||
@ApiResponse(
|
||||
code = 500,
|
||||
message = "Internal Server Error. " +
|
||||
"\n Server error occurred while fetching white label theme.",
|
||||
response = ErrorResponse.class)
|
||||
})
|
||||
Response getWhiteLabelTheme();
|
||||
|
||||
@PUT
|
||||
@Path("/reset")
|
||||
@ApiOperation(
|
||||
produces = MediaType.APPLICATION_JSON,
|
||||
httpMethod = HTTPConstants.HEADER_POST,
|
||||
value = "Reset whitelabel for tenant",
|
||||
notes = "Reset whitelabel to default for the tenant of the logged in user",
|
||||
tags = "Tenant Metadata Management",
|
||||
extensions = {
|
||||
@Extension(properties = {
|
||||
@ExtensionProperty(name = Constants.SCOPE, value = "perm:whitelabel:update")
|
||||
})
|
||||
}
|
||||
)
|
||||
@ApiResponses(
|
||||
value = {
|
||||
@ApiResponse(
|
||||
code = 200,
|
||||
message = "OK. \n Successfully fetched white label theme.",
|
||||
response = Metadata.class,
|
||||
responseHeaders = {
|
||||
@ResponseHeader(
|
||||
name = "Content-Type",
|
||||
description = "The content type of the body"),
|
||||
@ResponseHeader(
|
||||
name = "ETag",
|
||||
description = "Entity Tag of the response resource.\n" +
|
||||
"Used by caches, or in conditional requests."),
|
||||
@ResponseHeader(
|
||||
name = "Last-Modified",
|
||||
description = "Date and time the resource was last modified.\n" +
|
||||
"Used by caches, or in conditional requests."),
|
||||
}),
|
||||
@ApiResponse(
|
||||
code = 500,
|
||||
message = "Internal Server Error. " +
|
||||
"\n Server error occurred while deleting white label theme.",
|
||||
response = ErrorResponse.class)
|
||||
})
|
||||
Response resetWhiteLabel();
|
||||
}
|
||||
@ -0,0 +1,175 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.jaxrs.service.impl;
|
||||
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
import org.wso2.carbon.context.PrivilegedCarbonContext;
|
||||
import org.wso2.carbon.device.mgt.common.FileResponse;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.DeviceManagementException;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.MetadataManagementException;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.NotFoundException;
|
||||
import org.wso2.carbon.device.mgt.common.metadata.mgt.WhiteLabelTheme;
|
||||
import org.wso2.carbon.device.mgt.common.metadata.mgt.WhiteLabelThemeCreateRequest;
|
||||
import org.wso2.carbon.device.mgt.jaxrs.service.api.WhiteLabelService;
|
||||
import org.wso2.carbon.device.mgt.jaxrs.service.impl.util.RequestValidationUtil;
|
||||
import org.wso2.carbon.device.mgt.jaxrs.util.DeviceMgtAPIUtils;
|
||||
import javax.ws.rs.Consumes;
|
||||
import javax.ws.rs.GET;
|
||||
import javax.ws.rs.PUT;
|
||||
import javax.ws.rs.Path;
|
||||
import javax.ws.rs.Produces;
|
||||
import javax.ws.rs.PathParam;
|
||||
import javax.ws.rs.core.MediaType;
|
||||
import javax.ws.rs.core.Response;
|
||||
import java.io.ByteArrayInputStream;
|
||||
import java.io.IOException;
|
||||
|
||||
/**
|
||||
* This is the service class for metadata management.
|
||||
*/
|
||||
@Path("/whitelabel")
|
||||
@Produces(MediaType.APPLICATION_JSON)
|
||||
@Consumes(MediaType.APPLICATION_JSON)
|
||||
public class WhiteLabelServiceImpl implements WhiteLabelService {
|
||||
|
||||
private static final Log log = LogFactory.getLog(WhiteLabelServiceImpl.class);
|
||||
|
||||
@GET
|
||||
@Override
|
||||
@Path("/{tenantDomain}/favicon")
|
||||
public Response getWhiteLabelFavicon(@PathParam("tenantDomain") String tenantDomain) {
|
||||
try {
|
||||
FileResponse fileResponse = DeviceMgtAPIUtils.getWhiteLabelManagementService().getWhiteLabelFavicon(tenantDomain);
|
||||
return sendFileStream(fileResponse);
|
||||
} catch (NotFoundException e) {
|
||||
String msg = "Favicon white label image cannot be found in the system. Uploading the favicon white label image again might help solve the issue.";
|
||||
log.error(msg, e);
|
||||
return Response.status(Response.Status.NOT_FOUND).entity(msg).build();
|
||||
} catch (MetadataManagementException e) {
|
||||
String msg = "Error occurred while getting favicon";
|
||||
log.error(msg, e);
|
||||
return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(msg).build();
|
||||
}
|
||||
}
|
||||
|
||||
@GET
|
||||
@Override
|
||||
@Path("/{tenantDomain}/logo")
|
||||
public Response getWhiteLabelLogo(@PathParam("tenantDomain") String tenantDomain) {
|
||||
try {
|
||||
FileResponse fileResponse = DeviceMgtAPIUtils.getWhiteLabelManagementService().getWhiteLabelLogo(tenantDomain);
|
||||
return sendFileStream(fileResponse);
|
||||
} catch (NotFoundException e) {
|
||||
String msg = "Logo white label image cannot be found in the system. Uploading the logo white label image again might help solve the issue.";
|
||||
log.error(msg, e);
|
||||
return Response.status(Response.Status.NOT_FOUND).entity(msg).build();
|
||||
} catch (MetadataManagementException e) {
|
||||
String msg = "Error occurred while getting logo";
|
||||
log.error(msg, e);
|
||||
return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(msg).build();
|
||||
}
|
||||
}
|
||||
|
||||
@GET
|
||||
@Override
|
||||
@Path("/{tenantDomain}/icon")
|
||||
public Response getWhiteLabelLogoIcon(@PathParam("tenantDomain") String tenantDomain) {
|
||||
try {
|
||||
FileResponse fileResponse = DeviceMgtAPIUtils.getWhiteLabelManagementService().getWhiteLabelLogoIcon(tenantDomain);
|
||||
return sendFileStream(fileResponse);
|
||||
} catch (NotFoundException e) {
|
||||
String msg = "Icon white label image cannot be found in the system. Uploading the icon white label image again might help solve the issue.";
|
||||
log.error(msg, e);
|
||||
return Response.status(Response.Status.NOT_FOUND).entity(msg).build();
|
||||
} catch (MetadataManagementException e) {
|
||||
String msg = "Error occurred while getting logo";
|
||||
log.error(msg, e);
|
||||
return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(msg).build();
|
||||
}
|
||||
}
|
||||
|
||||
@PUT
|
||||
@Override
|
||||
public Response updateWhiteLabelTheme(WhiteLabelThemeCreateRequest whiteLabelThemeCreateRequest) {
|
||||
RequestValidationUtil.validateWhiteLabelTheme(whiteLabelThemeCreateRequest);
|
||||
try {
|
||||
WhiteLabelTheme createdWhiteLabelTheme = DeviceMgtAPIUtils.getWhiteLabelManagementService().updateWhiteLabelTheme(whiteLabelThemeCreateRequest);
|
||||
return Response.status(Response.Status.CREATED).entity(createdWhiteLabelTheme).build();
|
||||
} catch (MetadataManagementException e) {
|
||||
String msg = "Error occurred while creating whitelabel for tenant";
|
||||
log.error(msg, e);
|
||||
return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(msg).build();
|
||||
}
|
||||
}
|
||||
|
||||
@GET
|
||||
@Override
|
||||
public Response getWhiteLabelTheme() {
|
||||
try {
|
||||
String tenantDomain = PrivilegedCarbonContext.getThreadLocalCarbonContext().getTenantDomain();
|
||||
WhiteLabelTheme whiteLabelTheme = DeviceMgtAPIUtils.getWhiteLabelManagementService().getWhiteLabelTheme(tenantDomain);
|
||||
return Response.status(Response.Status.CREATED).entity(whiteLabelTheme).build();
|
||||
} catch (MetadataManagementException e) {
|
||||
String msg = "Error occurred while deleting whitelabel for tenant";
|
||||
log.error(msg, e);
|
||||
return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(msg).build();
|
||||
} catch (NotFoundException e) {
|
||||
String msg = "Not white label theme configured for this tenant";
|
||||
log.error(msg, e);
|
||||
return Response.status(Response.Status.BAD_REQUEST).entity(msg).build();
|
||||
} catch (DeviceManagementException e) {
|
||||
String msg = "Error occurred while retrieving tenant details of whitelabel";
|
||||
log.error(msg, e);
|
||||
return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(msg).build();
|
||||
}
|
||||
}
|
||||
|
||||
@PUT
|
||||
@Override
|
||||
@Path("/reset")
|
||||
public Response resetWhiteLabel() {
|
||||
try {
|
||||
DeviceMgtAPIUtils.getWhiteLabelManagementService().resetToDefaultWhiteLabelTheme();
|
||||
return Response.status(Response.Status.CREATED).entity("White label theme deleted successfully.").build();
|
||||
} catch (MetadataManagementException e) {
|
||||
String msg = "Error occurred while resetting whitelabel for tenant";
|
||||
log.error(msg, e);
|
||||
return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(msg).build();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Useful to send file responses
|
||||
*/
|
||||
private Response sendFileStream(FileResponse fileResponse) {
|
||||
try (ByteArrayInputStream binaryDuplicate = new ByteArrayInputStream(fileResponse.getFileContent())) {
|
||||
Response.ResponseBuilder response = Response
|
||||
.ok(binaryDuplicate, fileResponse.getMimeType());
|
||||
response.status(Response.Status.OK);
|
||||
response.header("Content-Length", fileResponse.getFileContent().length);
|
||||
return response.build();
|
||||
} catch (IOException e) {
|
||||
String msg = "Error occurred while creating input stream from buffer array. ";
|
||||
log.error(msg, e);
|
||||
return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(msg).build();
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,74 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.common;
|
||||
|
||||
public class FileResponse {
|
||||
private static final String DEFAULT_MIME_TYPE = "application/octet-stream";
|
||||
private byte[] fileContent;
|
||||
private String mimeType;
|
||||
|
||||
private String name;
|
||||
|
||||
public byte[] getFileContent() {
|
||||
return fileContent;
|
||||
}
|
||||
|
||||
public void setFileContent(byte[] fileContent) {
|
||||
this.fileContent = fileContent;
|
||||
}
|
||||
|
||||
public String getMimeType() {
|
||||
return mimeType;
|
||||
}
|
||||
|
||||
public void setMimeType(String mimeType) {
|
||||
this.mimeType = mimeType;
|
||||
}
|
||||
|
||||
public enum ImageExtension {
|
||||
SVG() {
|
||||
@Override
|
||||
public String mimeType() {
|
||||
return "image/svg+xml";
|
||||
}
|
||||
},
|
||||
PNG,
|
||||
JPG,
|
||||
JPEG,
|
||||
GIF;
|
||||
|
||||
public String mimeType() {
|
||||
return DEFAULT_MIME_TYPE;
|
||||
}
|
||||
|
||||
public static String mimeTypeOf(String extension) {
|
||||
if (extension.isEmpty()) {
|
||||
return DEFAULT_MIME_TYPE;
|
||||
}
|
||||
ImageExtension imageExtension = ImageExtension.valueOf(extension.toUpperCase());
|
||||
return imageExtension.mimeType();
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return this.name().toLowerCase();
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,34 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (pvt) Ltd. (http://entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.exceptions;
|
||||
|
||||
/**
|
||||
* This exception will be thrown when the requested application or platform not found.
|
||||
*/
|
||||
public class NotFoundException extends Exception {
|
||||
|
||||
public NotFoundException(String message, Throwable throwable) {
|
||||
super(message, throwable);
|
||||
}
|
||||
|
||||
public NotFoundException(String message) {
|
||||
super(message);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,59 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.metadata.mgt;
|
||||
|
||||
public class WhiteLabelArtifactPath {
|
||||
private String faviconPath;
|
||||
private String logoPath;
|
||||
private String logoIconPath;
|
||||
|
||||
public WhiteLabelArtifactPath() {
|
||||
|
||||
}
|
||||
|
||||
public WhiteLabelArtifactPath(String faviconPath, String logoPath, String logoIconPath) {
|
||||
this.faviconPath = faviconPath;
|
||||
this.logoPath = logoPath;
|
||||
this.logoIconPath = logoIconPath;
|
||||
}
|
||||
|
||||
public String getFaviconPath() {
|
||||
return faviconPath;
|
||||
}
|
||||
|
||||
public void setFaviconPath(String faviconPath) {
|
||||
this.faviconPath = faviconPath;
|
||||
}
|
||||
|
||||
public String getLogoPath() {
|
||||
return logoPath;
|
||||
}
|
||||
|
||||
public void setLogoPath(String logoPath) {
|
||||
this.logoPath = logoPath;
|
||||
}
|
||||
|
||||
public String getLogoIconPath() {
|
||||
return logoIconPath;
|
||||
}
|
||||
|
||||
public void setLogoIconPath(String logoIconPath) {
|
||||
this.logoIconPath = logoIconPath;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,57 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (pvt) Ltd. (http://entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.metadata.mgt;
|
||||
|
||||
public class WhiteLabelImage {
|
||||
private ImageLocationType imageLocationType;
|
||||
private String imageLocation;
|
||||
|
||||
public ImageLocationType getImageLocationType() {
|
||||
return imageLocationType;
|
||||
}
|
||||
|
||||
public void setImageLocationType(ImageLocationType imageLocationType) {
|
||||
this.imageLocationType = imageLocationType;
|
||||
}
|
||||
|
||||
public String getImageLocation() {
|
||||
return imageLocation;
|
||||
}
|
||||
|
||||
public void setImageLocation(String imageLocation) {
|
||||
this.imageLocation = imageLocation;
|
||||
}
|
||||
|
||||
public enum ImageName {
|
||||
FAVICON,
|
||||
LOGO,
|
||||
LOGO_ICON;
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return name().toLowerCase();
|
||||
}
|
||||
}
|
||||
|
||||
public enum ImageLocationType {
|
||||
URL,
|
||||
CUSTOM_FILE,
|
||||
DEFAULT_FILE
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,71 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (pvt) Ltd. (http://entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.metadata.mgt;
|
||||
|
||||
import com.google.gson.Gson;
|
||||
import com.google.gson.JsonElement;
|
||||
import org.wso2.carbon.device.mgt.common.Base64File;
|
||||
|
||||
public class WhiteLabelImageRequestPayload {
|
||||
private ImageType imageType;
|
||||
private JsonElement image;
|
||||
|
||||
public ImageType getImageType() {
|
||||
return imageType;
|
||||
}
|
||||
|
||||
public void setImageType(ImageType imageType) {
|
||||
this.imageType = imageType;
|
||||
}
|
||||
|
||||
public JsonElement getImage() {
|
||||
return image;
|
||||
}
|
||||
|
||||
public Base64File getImageAsBase64File() {
|
||||
if (imageType != ImageType.BASE64) {
|
||||
throw new IllegalStateException("Cannot convert image with Image type of " + imageType + " to base64.");
|
||||
}
|
||||
return new Gson().fromJson(image, Base64File.class);
|
||||
}
|
||||
|
||||
public String getImageAsUrl() {
|
||||
if (imageType != ImageType.URL) {
|
||||
throw new IllegalStateException("Cannot convert image with Image type of " + imageType + " to image url string.");
|
||||
}
|
||||
return new Gson().fromJson(image, String.class);
|
||||
}
|
||||
|
||||
public void setImage(JsonElement image) {
|
||||
this.image = image;
|
||||
}
|
||||
|
||||
public enum ImageType {
|
||||
URL,
|
||||
BASE64;
|
||||
|
||||
public WhiteLabelImage.ImageLocationType getDTOImageLocationType() {
|
||||
if (this == URL) {
|
||||
return WhiteLabelImage.ImageLocationType.URL;
|
||||
}
|
||||
return WhiteLabelImage.ImageLocationType.CUSTOM_FILE;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,83 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.metadata.mgt;
|
||||
|
||||
import org.wso2.carbon.device.mgt.common.FileResponse;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.DeviceManagementException;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.MetadataManagementException;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.NotFoundException;
|
||||
|
||||
/**
|
||||
* Defines the contract of WhiteLabelManagementService.
|
||||
*/
|
||||
public interface WhiteLabelManagementService {
|
||||
|
||||
/**
|
||||
* Use to get byte content of favicon whitelabel image
|
||||
* @return byte content of favicon
|
||||
* @throws MetadataManagementException if error occurred while retrieving favicon
|
||||
* @throws NotFoundException if favicon is not found
|
||||
*/
|
||||
FileResponse getWhiteLabelFavicon(String tenantDomain) throws
|
||||
MetadataManagementException, NotFoundException;
|
||||
|
||||
/**
|
||||
* Use to get byte content of logo whitelabel image
|
||||
* @return byte content of logo
|
||||
* @throws MetadataManagementException if error occurred while retrieving logo
|
||||
* @throws NotFoundException if logo is not found
|
||||
*/
|
||||
FileResponse getWhiteLabelLogo(String tenantDomain) throws
|
||||
MetadataManagementException, NotFoundException;
|
||||
|
||||
/**
|
||||
* Use to get byte content of logo icon whitelabel image
|
||||
* @return byte content of logo icon
|
||||
* @throws MetadataManagementException if error occurred while retrieving logo icon
|
||||
* @throws NotFoundException if logo icon is not found
|
||||
*/
|
||||
FileResponse getWhiteLabelLogoIcon(String tenantDomain) throws
|
||||
MetadataManagementException, NotFoundException;
|
||||
|
||||
/**
|
||||
* This method is useful to create & persist default white label theme for provided tenant if
|
||||
* it doesn't exist already
|
||||
* @throws MetadataManagementException if error while adding default white label theme
|
||||
*/
|
||||
void addDefaultWhiteLabelThemeIfNotExist(int tenantId) throws MetadataManagementException;
|
||||
|
||||
/**
|
||||
* This method is useful to reset existing white label to default whitelabel
|
||||
* @throws MetadataManagementException if error while resetting default white label theme
|
||||
*/
|
||||
void resetToDefaultWhiteLabelTheme() throws MetadataManagementException;
|
||||
|
||||
/**
|
||||
* This method is useful to update existing white label theme
|
||||
* @throws MetadataManagementException if error while updating existing white label theme
|
||||
*/
|
||||
WhiteLabelTheme updateWhiteLabelTheme(WhiteLabelThemeCreateRequest createWhiteLabelTheme)
|
||||
throws MetadataManagementException;
|
||||
|
||||
/**
|
||||
* This method is useful to get existing white label theme
|
||||
* @throws MetadataManagementException if error while getting existing white label theme
|
||||
*/
|
||||
WhiteLabelTheme getWhiteLabelTheme(String tenantDomain) throws MetadataManagementException, NotFoundException, DeviceManagementException;
|
||||
}
|
||||
@ -0,0 +1,67 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.metadata.mgt;
|
||||
|
||||
public class WhiteLabelTheme {
|
||||
private WhiteLabelImage faviconImage;
|
||||
private WhiteLabelImage logoImage;
|
||||
private WhiteLabelImage logoIconImage;
|
||||
private String footerText;
|
||||
private String appTitle;
|
||||
|
||||
public String getFooterText() {
|
||||
return footerText;
|
||||
}
|
||||
|
||||
public void setFooterText(String footerText) {
|
||||
this.footerText = footerText;
|
||||
}
|
||||
|
||||
public WhiteLabelImage getFaviconImage() {
|
||||
return faviconImage;
|
||||
}
|
||||
|
||||
public void setFaviconImage(WhiteLabelImage faviconImage) {
|
||||
this.faviconImage = faviconImage;
|
||||
}
|
||||
|
||||
public WhiteLabelImage getLogoImage() {
|
||||
return logoImage;
|
||||
}
|
||||
|
||||
public void setLogoImage(WhiteLabelImage logoImage) {
|
||||
this.logoImage = logoImage;
|
||||
}
|
||||
|
||||
public String getAppTitle() {
|
||||
return appTitle;
|
||||
}
|
||||
|
||||
public void setAppTitle(String appTitle) {
|
||||
this.appTitle = appTitle;
|
||||
}
|
||||
|
||||
public WhiteLabelImage getLogoIconImage() {
|
||||
return logoIconImage;
|
||||
}
|
||||
|
||||
public void setLogoIconImage(WhiteLabelImage logoIconImage) {
|
||||
this.logoIconImage = logoIconImage;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,67 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.metadata.mgt;
|
||||
|
||||
public class WhiteLabelThemeCreateRequest {
|
||||
private WhiteLabelImageRequestPayload favicon;
|
||||
private WhiteLabelImageRequestPayload logo;
|
||||
private WhiteLabelImageRequestPayload logoIcon;
|
||||
private String footerText;
|
||||
private String appTitle;
|
||||
|
||||
public WhiteLabelImageRequestPayload getFavicon() {
|
||||
return favicon;
|
||||
}
|
||||
|
||||
public void setFavicon(WhiteLabelImageRequestPayload favicon) {
|
||||
this.favicon = favicon;
|
||||
}
|
||||
|
||||
public WhiteLabelImageRequestPayload getLogo() {
|
||||
return logo;
|
||||
}
|
||||
|
||||
public void setLogo(WhiteLabelImageRequestPayload logo) {
|
||||
this.logo = logo;
|
||||
}
|
||||
|
||||
public String getFooterText() {
|
||||
return footerText;
|
||||
}
|
||||
|
||||
public void setFooterText(String footerText) {
|
||||
this.footerText = footerText;
|
||||
}
|
||||
|
||||
public String getAppTitle() {
|
||||
return appTitle;
|
||||
}
|
||||
|
||||
public void setAppTitle(String appTitle) {
|
||||
this.appTitle = appTitle;
|
||||
}
|
||||
|
||||
public WhiteLabelImageRequestPayload getLogoIcon() {
|
||||
return logoIcon;
|
||||
}
|
||||
|
||||
public void setLogoIcon(WhiteLabelImageRequestPayload logoIcon) {
|
||||
this.logoIcon = logoIcon;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,32 @@
|
||||
/* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.core.common.exception;
|
||||
|
||||
/**
|
||||
* Represents the exception thrown during storing and retrieving the artifacts.
|
||||
*/
|
||||
public class StorageManagementException extends Exception {
|
||||
public StorageManagementException(String message, Throwable ex) {
|
||||
super(message, ex);
|
||||
}
|
||||
|
||||
public StorageManagementException(String message) {
|
||||
super(message);
|
||||
}
|
||||
}
|
||||
|
||||
@ -0,0 +1,38 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.core.config.metadata.mgt;
|
||||
|
||||
import org.wso2.carbon.device.mgt.core.config.metadata.mgt.whitelabel.WhiteLabelConfiguration;
|
||||
|
||||
import javax.xml.bind.annotation.XmlElement;
|
||||
import javax.xml.bind.annotation.XmlRootElement;
|
||||
|
||||
@XmlRootElement(name = "MetaDataConfiguration")
|
||||
public class MetaDataConfiguration {
|
||||
private WhiteLabelConfiguration whiteLabelConfiguration;
|
||||
|
||||
@XmlElement(name = "WhiteLabelConfiguration", required = true)
|
||||
public WhiteLabelConfiguration getWhiteLabelConfiguration() {
|
||||
return whiteLabelConfiguration;
|
||||
}
|
||||
|
||||
public void setWhiteLabelConfiguration(WhiteLabelConfiguration whiteLabelConfiguration) {
|
||||
this.whiteLabelConfiguration = whiteLabelConfiguration;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,56 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.core.config.metadata.mgt.whitelabel;
|
||||
|
||||
import javax.xml.bind.annotation.XmlElement;
|
||||
import javax.xml.bind.annotation.XmlRootElement;
|
||||
|
||||
@XmlRootElement(name = "WhiteLabelConfiguration")
|
||||
public class WhiteLabelConfiguration {
|
||||
private String footerText;
|
||||
private String appTitle;
|
||||
private WhiteLabelImages whiteLabelImages;
|
||||
|
||||
@XmlElement(name = "FooterText", required = true)
|
||||
public String getFooterText() {
|
||||
return footerText;
|
||||
}
|
||||
|
||||
public void setFooterText(String footerText) {
|
||||
this.footerText = footerText;
|
||||
}
|
||||
|
||||
@XmlElement(name = "WhiteLabelImages", required = true)
|
||||
public WhiteLabelImages getWhiteLabelImages() {
|
||||
return whiteLabelImages;
|
||||
}
|
||||
|
||||
public void setWhiteLabelImages(WhiteLabelImages whiteLabelImages) {
|
||||
this.whiteLabelImages = whiteLabelImages;
|
||||
}
|
||||
|
||||
@XmlElement(name = "AppTitle", required = true)
|
||||
public String getAppTitle() {
|
||||
return appTitle;
|
||||
}
|
||||
|
||||
public void setAppTitle(String appTitle) {
|
||||
this.appTitle = appTitle;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,77 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.core.config.metadata.mgt.whitelabel;
|
||||
|
||||
import javax.xml.bind.annotation.XmlElement;
|
||||
import javax.xml.bind.annotation.XmlRootElement;
|
||||
|
||||
@XmlRootElement(name = "WhiteLabelImages")
|
||||
public class WhiteLabelImages {
|
||||
|
||||
private String storagePath;
|
||||
private String defaultImagesLocation;
|
||||
private String defaultFaviconName;
|
||||
private String defaultLogoName;
|
||||
private String defaultLogoIconName;
|
||||
|
||||
@XmlElement(name = "StoragePath", required = true)
|
||||
public String getStoragePath() {
|
||||
return storagePath;
|
||||
}
|
||||
|
||||
public void setStoragePath(String storagePath) {
|
||||
this.storagePath = storagePath;
|
||||
}
|
||||
|
||||
@XmlElement(name = "DefaultFaviconName", required = true)
|
||||
public String getDefaultFaviconName() {
|
||||
return defaultFaviconName;
|
||||
}
|
||||
|
||||
public void setDefaultFaviconName(String defaultFaviconName) {
|
||||
this.defaultFaviconName = defaultFaviconName;
|
||||
}
|
||||
|
||||
@XmlElement(name = "DefaultLogoName", required = true)
|
||||
public String getDefaultLogoName() {
|
||||
return defaultLogoName;
|
||||
}
|
||||
|
||||
public void setDefaultLogoName(String defaultLogoName) {
|
||||
this.defaultLogoName = defaultLogoName;
|
||||
}
|
||||
|
||||
@XmlElement(name = "DefaultImagesLocation", required = true)
|
||||
public String getDefaultImagesLocation() {
|
||||
return defaultImagesLocation;
|
||||
}
|
||||
|
||||
@XmlElement(name = "DefaultLogoIconName", required = true)
|
||||
public String getDefaultLogoIconName() {
|
||||
return defaultLogoIconName;
|
||||
}
|
||||
|
||||
public void setDefaultLogoIconName(String defaultLogoIconName) {
|
||||
this.defaultLogoIconName = defaultLogoIconName;
|
||||
}
|
||||
|
||||
public void setDefaultImagesLocation(String defaultImagesLocation) {
|
||||
this.defaultImagesLocation = defaultImagesLocation;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,458 @@
|
||||
/*
|
||||
* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.core.metadata.mgt;
|
||||
|
||||
import com.google.gson.Gson;
|
||||
import org.apache.commons.io.IOUtils;
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
import org.apache.http.HttpResponse;
|
||||
import org.apache.http.client.methods.HttpGet;
|
||||
import org.apache.http.impl.client.CloseableHttpClient;
|
||||
import org.apache.http.impl.client.HttpClients;
|
||||
import org.wso2.carbon.context.CarbonContext;
|
||||
import org.wso2.carbon.context.PrivilegedCarbonContext;
|
||||
import org.wso2.carbon.device.mgt.common.Base64File;
|
||||
import org.wso2.carbon.device.mgt.common.FileResponse;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.DeviceManagementException;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.MetadataManagementException;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.NotFoundException;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.TransactionManagementException;
|
||||
import org.wso2.carbon.device.mgt.common.metadata.mgt.Metadata;
|
||||
import org.wso2.carbon.device.mgt.common.metadata.mgt.WhiteLabelImage;
|
||||
import org.wso2.carbon.device.mgt.common.metadata.mgt.WhiteLabelImageRequestPayload;
|
||||
import org.wso2.carbon.device.mgt.common.metadata.mgt.WhiteLabelManagementService;
|
||||
import org.wso2.carbon.device.mgt.common.metadata.mgt.WhiteLabelTheme;
|
||||
import org.wso2.carbon.device.mgt.common.metadata.mgt.WhiteLabelThemeCreateRequest;
|
||||
import org.wso2.carbon.device.mgt.core.common.util.HttpUtil;
|
||||
import org.wso2.carbon.device.mgt.core.config.DeviceConfigurationManager;
|
||||
import org.wso2.carbon.device.mgt.core.config.metadata.mgt.MetaDataConfiguration;
|
||||
import org.wso2.carbon.device.mgt.core.config.metadata.mgt.whitelabel.WhiteLabelConfiguration;
|
||||
import org.wso2.carbon.device.mgt.core.internal.DeviceManagementDataHolder;
|
||||
import org.wso2.carbon.device.mgt.core.metadata.mgt.dao.MetadataDAO;
|
||||
import org.wso2.carbon.device.mgt.core.metadata.mgt.dao.MetadataManagementDAOException;
|
||||
import org.wso2.carbon.device.mgt.core.metadata.mgt.dao.MetadataManagementDAOFactory;
|
||||
import org.wso2.carbon.device.mgt.core.metadata.mgt.dao.util.MetadataConstants;
|
||||
import org.wso2.carbon.device.mgt.core.metadata.mgt.util.WhiteLabelStorageUtil;
|
||||
import org.wso2.carbon.device.mgt.core.util.DeviceManagerUtil;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.sql.SQLException;
|
||||
|
||||
/**
|
||||
* This class implements the MetadataManagementService.
|
||||
*/
|
||||
public class WhiteLabelManagementServiceImpl implements WhiteLabelManagementService {
|
||||
|
||||
private static final Log log = LogFactory.getLog(WhiteLabelManagementServiceImpl.class);
|
||||
|
||||
private final MetadataDAO metadataDAO;
|
||||
|
||||
public WhiteLabelManagementServiceImpl() {
|
||||
this.metadataDAO = MetadataManagementDAOFactory.getMetadataDAO();
|
||||
}
|
||||
|
||||
@Override
|
||||
public FileResponse getWhiteLabelFavicon(String tenantDomain) throws MetadataManagementException, NotFoundException {
|
||||
try {
|
||||
WhiteLabelTheme whiteLabelTheme = getWhiteLabelTheme(tenantDomain);
|
||||
return getImageFileResponse(whiteLabelTheme.getFaviconImage(), WhiteLabelImage.ImageName.FAVICON, tenantDomain);
|
||||
} catch (IOException e) {
|
||||
String msg = "Error occurred while getting byte content of favicon";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
} catch (DeviceManagementException e) {
|
||||
String msg = "Error occurred while getting tenant details of favicon";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public FileResponse getWhiteLabelLogo(String tenantDomain) throws MetadataManagementException, NotFoundException {
|
||||
try {
|
||||
WhiteLabelTheme whiteLabelTheme = getWhiteLabelTheme(tenantDomain);
|
||||
return getImageFileResponse(whiteLabelTheme.getLogoImage(), WhiteLabelImage.ImageName.LOGO, tenantDomain);
|
||||
} catch (IOException e) {
|
||||
String msg = "Error occurred while getting byte content of logo";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
} catch (DeviceManagementException e) {
|
||||
String msg = "Error occurred while getting tenant details of logo";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public FileResponse getWhiteLabelLogoIcon(String tenantDomain) throws MetadataManagementException, NotFoundException {
|
||||
try {
|
||||
WhiteLabelTheme whiteLabelTheme = getWhiteLabelTheme(tenantDomain);
|
||||
return getImageFileResponse(whiteLabelTheme.getLogoIconImage(), WhiteLabelImage.ImageName.LOGO_ICON, tenantDomain);
|
||||
} catch (IOException e) {
|
||||
String msg = "Error occurred while getting byte content of logo";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
} catch (DeviceManagementException e) {
|
||||
String msg = "Error occurred while getting tenant details of icon";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Useful to get white label image file response for provided {@link WhiteLabelImage.ImageName}
|
||||
*/
|
||||
private FileResponse getImageFileResponse(WhiteLabelImage image, WhiteLabelImage.ImageName imageName, String tenantDomain) throws
|
||||
IOException, MetadataManagementException, NotFoundException, DeviceManagementException {
|
||||
if (image.getImageLocationType() == WhiteLabelImage.ImageLocationType.URL) {
|
||||
return getImageFileResponseFromUrl(image.getImageLocation());
|
||||
}
|
||||
return WhiteLabelStorageUtil.getWhiteLabelImageStream(image, imageName, tenantDomain);
|
||||
}
|
||||
|
||||
/**
|
||||
* Useful to get white label image file response from provided url
|
||||
*/
|
||||
private FileResponse getImageFileResponseFromUrl(String url) throws IOException, NotFoundException {
|
||||
FileResponse fileResponse = new FileResponse();
|
||||
try(CloseableHttpClient client = HttpClients.createDefault()) {
|
||||
HttpGet imageGetRequest = new HttpGet(url);
|
||||
HttpResponse response = client.execute(imageGetRequest);
|
||||
InputStream imageStream = response.getEntity().getContent();
|
||||
if (imageStream == null) {
|
||||
String msg = "Failed to retrieve the image from url: " + url;
|
||||
log.error(msg);
|
||||
throw new NotFoundException(msg);
|
||||
}
|
||||
byte[] fileContent = IOUtils.toByteArray(imageStream);
|
||||
fileResponse.setFileContent(fileContent);
|
||||
String mimeType = HttpUtil.getContentType(response);
|
||||
fileResponse.setMimeType(mimeType);
|
||||
return fileResponse;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@Override
|
||||
public void addDefaultWhiteLabelThemeIfNotExist(int tenantId) throws MetadataManagementException {
|
||||
try {
|
||||
MetadataManagementDAOFactory.beginTransaction();
|
||||
if (!metadataDAO.isExist(tenantId, MetadataConstants.WHITELABEL_META_KEY)) {
|
||||
WhiteLabelTheme whiteLabelTheme = getDefaultWhiteLabelTheme();
|
||||
Metadata metadata = constructWhiteLabelThemeMetadata(whiteLabelTheme);
|
||||
metadataDAO.addMetadata(tenantId, metadata);
|
||||
if (log.isDebugEnabled()) {
|
||||
log.debug("White label metadata entry has inserted successfully");
|
||||
}
|
||||
}
|
||||
MetadataManagementDAOFactory.commitTransaction();
|
||||
} catch (MetadataManagementDAOException e) {
|
||||
MetadataManagementDAOFactory.rollbackTransaction();
|
||||
String msg = "Error occurred while inserting default whitelabel metadata entry.";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
} catch (TransactionManagementException e) {
|
||||
String msg = "Error occurred while opening a connection to the data source";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
} finally {
|
||||
MetadataManagementDAOFactory.closeConnection();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public void resetToDefaultWhiteLabelTheme() throws MetadataManagementException {
|
||||
int tenantId = PrivilegedCarbonContext.getThreadLocalCarbonContext().getTenantId(true);
|
||||
WhiteLabelTheme whiteLabelTheme = getDefaultWhiteLabelTheme();
|
||||
Metadata metadata = constructWhiteLabelThemeMetadata(whiteLabelTheme);
|
||||
DeviceManagementDataHolder.getInstance().getMetadataManagementService().updateMetadata(metadata);
|
||||
WhiteLabelStorageUtil.deleteWhiteLabelImageForTenantIfExists(tenantId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct and return default whitelabel detail bean {@link WhiteLabelImage}
|
||||
*/
|
||||
private WhiteLabelTheme getDefaultWhiteLabelTheme() {
|
||||
String footerText = getDefaultFooterText();
|
||||
String appTitle = getDefaultAppTitle();
|
||||
WhiteLabelImage favicon = constructDefaultFaviconImage();
|
||||
WhiteLabelImage logo = constructDefaultLogoImage();
|
||||
WhiteLabelImage logoIcon = constructDefaultLogoIconImage();
|
||||
WhiteLabelTheme defaultTheme = new WhiteLabelTheme();
|
||||
defaultTheme.setFooterText(footerText);
|
||||
defaultTheme.setAppTitle(appTitle);
|
||||
defaultTheme.setLogoImage(logo);
|
||||
defaultTheme.setLogoIconImage(logoIcon);
|
||||
defaultTheme.setFaviconImage(favicon);
|
||||
return defaultTheme;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get default whitelabel label page title from config
|
||||
*/
|
||||
private String getDefaultAppTitle() {
|
||||
MetaDataConfiguration metaDataConfiguration = DeviceConfigurationManager.getInstance().
|
||||
getDeviceManagementConfig().getMetaDataConfiguration();
|
||||
WhiteLabelConfiguration whiteLabelConfiguration = metaDataConfiguration.getWhiteLabelConfiguration();
|
||||
return whiteLabelConfiguration.getAppTitle();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get default whitelabel label footer from config
|
||||
*/
|
||||
private String getDefaultFooterText() {
|
||||
MetaDataConfiguration metaDataConfiguration = DeviceConfigurationManager.getInstance().
|
||||
getDeviceManagementConfig().getMetaDataConfiguration();
|
||||
WhiteLabelConfiguration whiteLabelConfiguration = metaDataConfiguration.getWhiteLabelConfiguration();
|
||||
return whiteLabelConfiguration.getFooterText();
|
||||
}
|
||||
|
||||
/**
|
||||
* This is useful to construct and get the default favicon whitelabel image
|
||||
*
|
||||
* @return {@link WhiteLabelImage}
|
||||
*/
|
||||
private WhiteLabelImage constructDefaultFaviconImage() {
|
||||
MetaDataConfiguration metaDataConfiguration = DeviceConfigurationManager.getInstance().
|
||||
getDeviceManagementConfig().getMetaDataConfiguration();
|
||||
WhiteLabelConfiguration whiteLabelConfiguration = metaDataConfiguration.getWhiteLabelConfiguration();
|
||||
WhiteLabelImage favicon = new WhiteLabelImage();
|
||||
favicon.setImageLocation(whiteLabelConfiguration.getWhiteLabelImages().getDefaultFaviconName());
|
||||
setDefaultWhiteLabelImageCommonProperties(favicon);
|
||||
return favicon;
|
||||
}
|
||||
|
||||
/**
|
||||
* This is useful to construct and get the default logo whitelabel image
|
||||
*
|
||||
* @return {@link WhiteLabelImage}
|
||||
*/
|
||||
private WhiteLabelImage constructDefaultLogoImage() {
|
||||
MetaDataConfiguration metaDataConfiguration = DeviceConfigurationManager.getInstance().
|
||||
getDeviceManagementConfig().getMetaDataConfiguration();
|
||||
WhiteLabelConfiguration whiteLabelConfiguration = metaDataConfiguration.getWhiteLabelConfiguration();
|
||||
WhiteLabelImage logo = new WhiteLabelImage();
|
||||
logo.setImageLocation(whiteLabelConfiguration.getWhiteLabelImages().getDefaultLogoName());
|
||||
setDefaultWhiteLabelImageCommonProperties(logo);
|
||||
return logo;
|
||||
}
|
||||
|
||||
/**
|
||||
* This is useful to construct and get the default logo whitelabel image
|
||||
*
|
||||
* @return {@link WhiteLabelImage}
|
||||
*/
|
||||
private WhiteLabelImage constructDefaultLogoIconImage() {
|
||||
MetaDataConfiguration metaDataConfiguration = DeviceConfigurationManager.getInstance().
|
||||
getDeviceManagementConfig().getMetaDataConfiguration();
|
||||
WhiteLabelConfiguration whiteLabelConfiguration = metaDataConfiguration.getWhiteLabelConfiguration();
|
||||
WhiteLabelImage logoIcon = new WhiteLabelImage();
|
||||
logoIcon.setImageLocation(whiteLabelConfiguration.getWhiteLabelImages().getDefaultLogoIconName());
|
||||
setDefaultWhiteLabelImageCommonProperties(logoIcon);
|
||||
return logoIcon;
|
||||
}
|
||||
|
||||
/**
|
||||
* This is useful to set common properties such as DEFAULT_FILE type for {@link WhiteLabelImage.ImageLocationType}
|
||||
* for default white label image bean{@link WhiteLabelImage}
|
||||
*/
|
||||
private void setDefaultWhiteLabelImageCommonProperties(WhiteLabelImage image) {
|
||||
image.setImageLocationType(WhiteLabelImage.ImageLocationType.DEFAULT_FILE);
|
||||
}
|
||||
|
||||
@Override
|
||||
public WhiteLabelTheme updateWhiteLabelTheme(WhiteLabelThemeCreateRequest createWhiteLabelTheme)
|
||||
throws MetadataManagementException {
|
||||
if (log.isDebugEnabled()) {
|
||||
log.debug("Creating Metadata : [" + createWhiteLabelTheme.toString() + "]");
|
||||
}
|
||||
int tenantId = PrivilegedCarbonContext.getThreadLocalCarbonContext().getTenantId(true);
|
||||
String tenantDomain = PrivilegedCarbonContext.getThreadLocalCarbonContext().getTenantDomain(true);
|
||||
File existingFaviconImage = null;
|
||||
File existingLogoImage = null;
|
||||
File existingLogoIconImage = null;
|
||||
try {
|
||||
WhiteLabelTheme theme = getWhiteLabelTheme(tenantDomain);
|
||||
if (theme.getFaviconImage().getImageLocationType() == WhiteLabelImage.ImageLocationType.CUSTOM_FILE) {
|
||||
existingFaviconImage = WhiteLabelStorageUtil.getWhiteLabelImageFile(theme.getFaviconImage(), WhiteLabelImage.ImageName.FAVICON, tenantDomain);
|
||||
}
|
||||
if (theme.getLogoImage().getImageLocationType() == WhiteLabelImage.ImageLocationType.CUSTOM_FILE) {
|
||||
existingLogoImage = WhiteLabelStorageUtil.getWhiteLabelImageFile(theme.getLogoImage(), WhiteLabelImage.ImageName.LOGO, tenantDomain);
|
||||
}
|
||||
if (theme.getLogoIconImage().getImageLocationType() == WhiteLabelImage.ImageLocationType.CUSTOM_FILE) {
|
||||
existingLogoIconImage = WhiteLabelStorageUtil.getWhiteLabelImageFile(theme.getLogoIconImage(), WhiteLabelImage.ImageName.LOGO_ICON, tenantDomain);
|
||||
}
|
||||
storeWhiteLabelImageIfRequired(createWhiteLabelTheme.getFavicon(), WhiteLabelImage.ImageName.FAVICON, tenantId);
|
||||
storeWhiteLabelImageIfRequired(createWhiteLabelTheme.getLogo(), WhiteLabelImage.ImageName.LOGO, tenantId);
|
||||
storeWhiteLabelImageIfRequired(createWhiteLabelTheme.getLogoIcon(), WhiteLabelImage.ImageName.LOGO_ICON, tenantId);
|
||||
WhiteLabelTheme whiteLabelTheme = constructWhiteLabelTheme(createWhiteLabelTheme);
|
||||
Metadata metadataWhiteLabelTheme = constructWhiteLabelThemeMetadata(whiteLabelTheme);
|
||||
try {
|
||||
MetadataManagementDAOFactory.beginTransaction();
|
||||
metadataDAO.updateMetadata(tenantId, metadataWhiteLabelTheme);
|
||||
MetadataManagementDAOFactory.commitTransaction();
|
||||
if (log.isDebugEnabled()) {
|
||||
log.debug("Metadata entry created successfully. " + createWhiteLabelTheme);
|
||||
}
|
||||
return whiteLabelTheme;
|
||||
} catch (MetadataManagementDAOException e) {
|
||||
MetadataManagementDAOFactory.rollbackTransaction();
|
||||
restoreWhiteLabelImages(existingFaviconImage, existingLogoImage, existingLogoIconImage, tenantId);
|
||||
String msg = "Error occurred while creating the metadata entry. " + createWhiteLabelTheme;
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
} catch (TransactionManagementException e) {
|
||||
restoreWhiteLabelImages(existingFaviconImage, existingLogoImage, existingLogoIconImage, tenantId);
|
||||
String msg = "Error occurred while opening a connection to the data source";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException("Error occurred while creating metadata record", e);
|
||||
} finally {
|
||||
MetadataManagementDAOFactory.closeConnection();
|
||||
}
|
||||
} catch (NotFoundException e) {
|
||||
String msg = "Error occurred while retrieving existing white label theme";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
} catch (DeviceManagementException e) {
|
||||
String msg = "Error occurred while getting tenant details of white label";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This is method is useful to restore provided existing white label images (i.e: favicon/logo).
|
||||
* For example if any exception occurred white updating/deleting white label, this method can be used to
|
||||
* restore the existing images in any case. Note that the existing images should be first loaded so that
|
||||
* those can be passed to this method in order to restore.
|
||||
*
|
||||
* @param existingFavicon existing favicon image file
|
||||
* @param existingLogo existing logo image file
|
||||
*/
|
||||
private void restoreWhiteLabelImages(File existingFavicon, File existingLogo, File existingLogoIcon, int tenantId)
|
||||
throws MetadataManagementException {
|
||||
WhiteLabelStorageUtil.deleteWhiteLabelImageForTenantIfExists(tenantId);
|
||||
if (existingFavicon != null) {
|
||||
WhiteLabelStorageUtil.storeWhiteLabelImage(existingFavicon, WhiteLabelImage.ImageName.FAVICON, tenantId);
|
||||
}
|
||||
if (existingLogo != null) {
|
||||
WhiteLabelStorageUtil.storeWhiteLabelImage(existingLogo, WhiteLabelImage.ImageName.LOGO, tenantId);
|
||||
}
|
||||
if (existingLogoIcon != null) {
|
||||
WhiteLabelStorageUtil.storeWhiteLabelImage(existingLogoIcon, WhiteLabelImage.ImageName.LOGO_ICON, tenantId);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This handles storing provided white label image if required.
|
||||
* For example if the provided white label image is of URL type it doesn't need to be stored
|
||||
*
|
||||
* @param whiteLabelImage image to be stored
|
||||
* @param imageName (i.e: FAVICON)
|
||||
*/
|
||||
private void storeWhiteLabelImageIfRequired(WhiteLabelImageRequestPayload whiteLabelImage,
|
||||
WhiteLabelImage.ImageName imageName, int tenantId)
|
||||
throws MetadataManagementException {
|
||||
if (whiteLabelImage.getImageType() == WhiteLabelImageRequestPayload.ImageType.BASE64) {
|
||||
Base64File imageBase64 = new Gson().fromJson(whiteLabelImage.getImage(), Base64File.class);
|
||||
WhiteLabelStorageUtil.updateWhiteLabelImage(imageBase64, imageName, tenantId);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate {@link WhiteLabelTheme} from provided {@link WhiteLabelThemeCreateRequest}
|
||||
*/
|
||||
private WhiteLabelTheme constructWhiteLabelTheme(WhiteLabelThemeCreateRequest whiteLabelThemeCreateRequest) {
|
||||
WhiteLabelTheme whiteLabelTheme = new WhiteLabelTheme();
|
||||
WhiteLabelImageRequestPayload faviconPayload = whiteLabelThemeCreateRequest.getFavicon();
|
||||
WhiteLabelImageRequestPayload logoPayload = whiteLabelThemeCreateRequest.getLogo();
|
||||
WhiteLabelImageRequestPayload logoIconPayload = whiteLabelThemeCreateRequest.getLogoIcon();
|
||||
WhiteLabelImage faviconImage = constructWhiteLabelImageDTO(faviconPayload);
|
||||
WhiteLabelImage logoImage = constructWhiteLabelImageDTO(logoPayload);
|
||||
WhiteLabelImage logoIconImage = constructWhiteLabelImageDTO(logoIconPayload);
|
||||
whiteLabelTheme.setFaviconImage(faviconImage);
|
||||
whiteLabelTheme.setLogoImage(logoImage);
|
||||
whiteLabelTheme.setLogoIconImage(logoIconImage);
|
||||
whiteLabelTheme.setFooterText(whiteLabelThemeCreateRequest.getFooterText());
|
||||
whiteLabelTheme.setAppTitle(whiteLabelThemeCreateRequest.getAppTitle());
|
||||
return whiteLabelTheme;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate {@link WhiteLabelImage} from provided {@link WhiteLabelImageRequestPayload}
|
||||
*/
|
||||
private WhiteLabelImage constructWhiteLabelImageDTO(WhiteLabelImageRequestPayload image) {
|
||||
WhiteLabelImage imageResponse = new WhiteLabelImage();
|
||||
WhiteLabelImage.ImageLocationType imageLocationType = image.getImageType().getDTOImageLocationType();
|
||||
imageResponse.setImageLocationType(imageLocationType);
|
||||
String imageLocation;
|
||||
if (image.getImageType() == WhiteLabelImageRequestPayload.ImageType.BASE64) {
|
||||
Base64File imageBase64 = image.getImageAsBase64File();
|
||||
imageLocation = imageBase64.getName();
|
||||
} else {
|
||||
imageLocation = image.getImageAsUrl();
|
||||
}
|
||||
imageResponse.setImageLocation(imageLocation);
|
||||
return imageResponse;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate {@link Metadata} from provided {@link WhiteLabelImage}
|
||||
*/
|
||||
private Metadata constructWhiteLabelThemeMetadata(WhiteLabelTheme whiteLabelTheme) {
|
||||
String whiteLabelThemeJsonString = new Gson().toJson(whiteLabelTheme);
|
||||
Metadata metadata = new Metadata();
|
||||
metadata.setMetaKey(MetadataConstants.WHITELABEL_META_KEY);
|
||||
metadata.setMetaValue(whiteLabelThemeJsonString);
|
||||
return metadata;
|
||||
}
|
||||
|
||||
@Override
|
||||
public WhiteLabelTheme getWhiteLabelTheme(String tenantDomain) throws MetadataManagementException, NotFoundException, DeviceManagementException {
|
||||
int tenantId = DeviceManagerUtil.getTenantId(tenantDomain);
|
||||
if (log.isDebugEnabled()) {
|
||||
log.debug("Retrieving whitelabel theme for tenant: " + tenantId);
|
||||
}
|
||||
try {
|
||||
MetadataManagementDAOFactory.openConnection();
|
||||
Metadata metadata = metadataDAO.getMetadata(tenantId, MetadataConstants.WHITELABEL_META_KEY);
|
||||
if (metadata == null) {
|
||||
String msg = "Whitelabel theme not found for tenant: " + tenantId;
|
||||
log.error(msg);
|
||||
throw new NotFoundException(msg);
|
||||
}
|
||||
return new Gson().fromJson(metadata.getMetaValue(), WhiteLabelTheme.class);
|
||||
} catch (MetadataManagementDAOException e) {
|
||||
String msg = "Error occurred while retrieving white label theme for tenant:" + tenantId;
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
} catch (SQLException e) {
|
||||
String msg = "Error occurred while opening a connection to the data source";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
} finally {
|
||||
MetadataManagementDAOFactory.closeConnection();
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,22 @@
|
||||
/* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.core.metadata.mgt.dao.util;
|
||||
|
||||
public class MetadataConstants {
|
||||
public static final String WHITELABEL_META_KEY = "whitelabel";
|
||||
}
|
||||
@ -0,0 +1,222 @@
|
||||
/* Copyright (c) 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||
*
|
||||
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||
* Version 2.0 (the "License"); you may not use this file except
|
||||
* in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
package org.wso2.carbon.device.mgt.core.metadata.mgt.util;
|
||||
|
||||
import org.apache.commons.io.IOUtils;
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
import org.wso2.carbon.context.PrivilegedCarbonContext;
|
||||
import org.wso2.carbon.device.mgt.common.Base64File;
|
||||
import org.wso2.carbon.device.mgt.common.FileResponse;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.DeviceManagementException;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.MetadataManagementException;
|
||||
import org.wso2.carbon.device.mgt.common.exceptions.NotFoundException;
|
||||
import org.wso2.carbon.device.mgt.common.metadata.mgt.WhiteLabelImage;
|
||||
import org.wso2.carbon.device.mgt.core.common.exception.StorageManagementException;
|
||||
import org.wso2.carbon.device.mgt.core.common.util.FileUtil;
|
||||
import org.wso2.carbon.device.mgt.core.common.util.StorageManagementUtil;
|
||||
import org.wso2.carbon.device.mgt.core.config.DeviceConfigurationManager;
|
||||
import org.wso2.carbon.device.mgt.core.config.metadata.mgt.MetaDataConfiguration;
|
||||
import org.wso2.carbon.device.mgt.core.util.DeviceManagerUtil;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
|
||||
/**
|
||||
* This class contains the default concrete implementation of ApplicationStorage Management.
|
||||
*/
|
||||
public class WhiteLabelStorageUtil {
|
||||
private static final Log log = LogFactory.getLog(WhiteLabelStorageUtil.class);
|
||||
private static final MetaDataConfiguration metadataConfig;
|
||||
private static final String STORAGE_PATH;
|
||||
|
||||
static {
|
||||
metadataConfig = DeviceConfigurationManager.getInstance().getDeviceManagementConfig().getMetaDataConfiguration();
|
||||
if (metadataConfig == null) {
|
||||
throw new RuntimeException("Meta configuration is not found in cdm-config.xml");
|
||||
}
|
||||
STORAGE_PATH = metadataConfig.getWhiteLabelConfiguration().getWhiteLabelImages().getStoragePath();
|
||||
}
|
||||
|
||||
/**
|
||||
* Store provided white label {@link Base64File} image
|
||||
*
|
||||
* @param image base64 image file
|
||||
* @param imageName {@link WhiteLabelImage.ImageName} (i.e FAVICON)
|
||||
*/
|
||||
public static void storeWhiteLabelImage(Base64File image, WhiteLabelImage.ImageName imageName, int tenantId)
|
||||
throws MetadataManagementException {
|
||||
String storedLocation;
|
||||
try {
|
||||
String imageStoringBaseDirPath = STORAGE_PATH + File.separator + tenantId;
|
||||
StorageManagementUtil.createArtifactDirectory(imageStoringBaseDirPath);
|
||||
String storingDir = imageStoringBaseDirPath + File.separator + imageName;
|
||||
StorageManagementUtil.createArtifactDirectory(storingDir);
|
||||
storedLocation = storingDir + File.separator + image.getName();
|
||||
StorageManagementUtil.saveFile(image, storedLocation);
|
||||
} catch (IOException e) {
|
||||
String msg = "IO Exception occurred while saving whitelabel artifacts for the tenant " + tenantId;
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
} catch (StorageManagementException e) {
|
||||
String msg = "Error occurred while uploading white label image artifacts";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Store provided white label {@link File} image
|
||||
*
|
||||
* @param image white label file
|
||||
* @param imageName {@link WhiteLabelImage.ImageName} (i.e FAVICON)
|
||||
*/
|
||||
public static void storeWhiteLabelImage(File image, WhiteLabelImage.ImageName imageName, int tenantId) throws
|
||||
MetadataManagementException {
|
||||
try {
|
||||
storeWhiteLabelImage(FileUtil.fileToBase64File(image), imageName, tenantId);
|
||||
} catch (IOException e) {
|
||||
String msg = "Error occurred when converting provided File object to Base64File class";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Update white label image for provided tenant
|
||||
*
|
||||
* @param image {@link Base64File} white label file
|
||||
* @param imageName (i.e: FAVICON)
|
||||
*/
|
||||
public static void updateWhiteLabelImage(Base64File image, WhiteLabelImage.ImageName imageName, int tenantId)
|
||||
throws MetadataManagementException {
|
||||
deleteWhiteLabelImageIfExists(imageName, tenantId);
|
||||
storeWhiteLabelImage(image, imageName, tenantId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Use to get a given {@link WhiteLabelImage.ImageName (i.e: LOGO)} white label image File
|
||||
*
|
||||
* @param image detail bean
|
||||
* @param imageName (i.e: LOGO)
|
||||
* @return white label image file {@link File}
|
||||
*/
|
||||
public static File getWhiteLabelImageFile(WhiteLabelImage image, WhiteLabelImage.ImageName imageName, String tenantDomain)
|
||||
throws MetadataManagementException, DeviceManagementException {
|
||||
String fullPathToImage = getPathToImage(image, imageName, tenantDomain);
|
||||
return new File(fullPathToImage);
|
||||
}
|
||||
|
||||
/**
|
||||
* Useful to get the given {@link WhiteLabelImage.ImageName (i.e: LOGO)} white label image InputStream
|
||||
*
|
||||
* @param image - white label image detail bean
|
||||
* @param imageName (i.e: LOGO)
|
||||
* @return white label image input stream
|
||||
*/
|
||||
public static FileResponse getWhiteLabelImageStream(WhiteLabelImage image, WhiteLabelImage.ImageName imageName, String tenantDomain)
|
||||
throws MetadataManagementException, NotFoundException, DeviceManagementException {
|
||||
FileResponse fileResponse = new FileResponse();
|
||||
String fullPathToFile = getPathToImage(image, imageName, tenantDomain);
|
||||
try {
|
||||
InputStream imageStream = StorageManagementUtil.getInputStream(fullPathToFile);
|
||||
if (imageStream == null) {
|
||||
String msg = "Failed to get the " + imageName + " image with the file name: " + fullPathToFile;
|
||||
log.error(msg);
|
||||
throw new NotFoundException(msg);
|
||||
}
|
||||
byte[] fileContent = IOUtils.toByteArray(imageStream);
|
||||
String fileExtension = FileUtil.extractFileExtensionFromFilePath(image.getImageLocation());
|
||||
String mimeType = FileResponse.ImageExtension.mimeTypeOf(fileExtension);
|
||||
fileResponse.setMimeType(mimeType);
|
||||
fileResponse.setFileContent(fileContent);
|
||||
return fileResponse;
|
||||
} catch (IOException e) {
|
||||
String msg = "Error occurred when accessing the file in file path: " + fullPathToFile;
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct the path to white label image in the file system and return
|
||||
*
|
||||
* @param image - white label image detail bean
|
||||
* @param imageName (i.e: LOGO)
|
||||
* @return Full path to white label image in the system
|
||||
*/
|
||||
private static String getPathToImage(WhiteLabelImage image, WhiteLabelImage.ImageName imageName, String tenantDomain)
|
||||
throws MetadataManagementException, DeviceManagementException {
|
||||
WhiteLabelImage.ImageLocationType imageLocationType = image.getImageLocationType();
|
||||
if (imageLocationType == WhiteLabelImage.ImageLocationType.URL) {
|
||||
String msg = "White label images of URL type is not stored, hence it doesn't have a path in file system.";
|
||||
log.error(msg);
|
||||
throw new MetadataManagementException(msg);
|
||||
}
|
||||
int tenantId = 0;
|
||||
try {
|
||||
tenantId = DeviceManagerUtil.getTenantId(tenantDomain);
|
||||
} catch (DeviceManagementException e) {
|
||||
String msg = "Error occurred while getting tenant details of logo";
|
||||
log.error(msg, e);
|
||||
throw new DeviceManagementException(msg, e);
|
||||
}
|
||||
String fileName = image.getImageLocation();
|
||||
String filePath = String.valueOf(tenantId);
|
||||
if (imageLocationType == WhiteLabelImage.ImageLocationType.DEFAULT_FILE) {
|
||||
filePath = metadataConfig.getWhiteLabelConfiguration().getWhiteLabelImages().getDefaultImagesLocation();
|
||||
}
|
||||
return STORAGE_PATH + File.separator + filePath + File.separator + imageName + File.separator + fileName;
|
||||
}
|
||||
|
||||
/***
|
||||
* This method is responsible to delete provided white label image file which if exist
|
||||
*/
|
||||
public static void deleteWhiteLabelImageIfExists(WhiteLabelImage.ImageName imageName, int tenantId) throws MetadataManagementException {
|
||||
String artifactPath = STORAGE_PATH + File.separator + tenantId + File.separator + imageName;
|
||||
File artifact = new File(artifactPath);
|
||||
if (artifact.exists()) {
|
||||
try {
|
||||
StorageManagementUtil.delete(artifact);
|
||||
} catch (IOException e) {
|
||||
String msg = "Error occurred while deleting whitelabel artifacts";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/***
|
||||
* This method is responsible to delete all white label images for provided tenant
|
||||
*/
|
||||
public static void deleteWhiteLabelImageForTenantIfExists(int tenantId) throws MetadataManagementException {
|
||||
String artifactPath = STORAGE_PATH + File.separator + tenantId;
|
||||
File artifact = new File(artifactPath);
|
||||
if (artifact.exists()) {
|
||||
try {
|
||||
StorageManagementUtil.delete(artifact);
|
||||
} catch (IOException e) {
|
||||
String msg = "Error occurred while deleting whitelabel artifacts";
|
||||
log.error(msg, e);
|
||||
throw new MetadataManagementException(msg, e);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue