Examples with IOutputPropertyDescriptor org.apereo.portal.layout.om.IOutputPropertyDescriptor used on opensource projects

Example 1 with IOutputPropertyDescriptor

use of org.apereo.portal.layout.om.IOutputPropertyDescriptor in project uPortal by Jasig.

the class StylesheetDescriptorImporterExporter method importData.

/* (non-Javadoc)
     * @see org.apereo.portal.io.xml.IDataImporterExporter#importData(java.lang.Object)
     */
@Transactional
@Override
public void importData(ExternalStylesheetDescriptor data) {
    final String stylesheetName = data.getName();
    final String uri = data.getUri();
    IStylesheetDescriptor stylesheetDescriptor = this.stylesheetDescriptorDao.getStylesheetDescriptorByName(stylesheetName);
    if (stylesheetDescriptor == null) {
        stylesheetDescriptor = this.stylesheetDescriptorDao.createStylesheetDescriptor(stylesheetName, uri);
    } else {
        stylesheetDescriptor.setStylesheetResource(uri);
    }
    stylesheetDescriptor.setUrlNodeSyntaxHelperName(data.getUrlSyntaxHelper());
    stylesheetDescriptor.setDescription(data.getDescription());
    final List<ExternalOutputPropertyDescriptor> extOutputProperties = data.getOutputProperties();
    final List<IOutputPropertyDescriptor> outputPropertyDescriptors = new ArrayList<IOutputPropertyDescriptor>(extOutputProperties.size());
    for (final ExternalOutputPropertyDescriptor extOutputProperty : extOutputProperties) {
        final String name = extOutputProperty.getName();
        final Scope scope = Scope.valueOf(extOutputProperty.getScope().name());
        final OutputPropertyDescriptorImpl outputPropertyDescriptor = new OutputPropertyDescriptorImpl(name, scope);
        outputPropertyDescriptor.setDefaultValue(extOutputProperty.getDefaultValue());
        outputPropertyDescriptor.setDescription(extOutputProperty.getDescription());
        outputPropertyDescriptors.add(outputPropertyDescriptor);
    }
    stylesheetDescriptor.setOutputPropertyDescriptors(outputPropertyDescriptors);
    final List<ExternalStylesheetParameterDescriptor> extStylesheetParameters = data.getStylesheetParameters();
    final List<IStylesheetParameterDescriptor> stylesheetParameterDescriptors = new ArrayList<IStylesheetParameterDescriptor>(extOutputProperties.size());
    for (final ExternalStylesheetParameterDescriptor extStylesheetParameter : extStylesheetParameters) {
        final String name = extStylesheetParameter.getName();
        final Scope scope = Scope.valueOf(extStylesheetParameter.getScope().name());
        final StylesheetParameterDescriptorImpl stylesheetParameterDescriptor = new StylesheetParameterDescriptorImpl(name, scope);
        stylesheetParameterDescriptor.setDefaultValue(extStylesheetParameter.getDefaultValue());
        stylesheetParameterDescriptor.setDescription(extStylesheetParameter.getDescription());
        stylesheetParameterDescriptors.add(stylesheetParameterDescriptor);
    }
    stylesheetDescriptor.setStylesheetParameterDescriptors(stylesheetParameterDescriptors);
    final List<ExternalLayoutAttributeDescriptor> extLayoutAttributes = data.getLayoutAttributes();
    final List<ILayoutAttributeDescriptor> layoutAttributeDescriptors = new ArrayList<ILayoutAttributeDescriptor>(extOutputProperties.size());
    for (final ExternalLayoutAttributeDescriptor extLayoutAttribute : extLayoutAttributes) {
        final String name = extLayoutAttribute.getName();
        final Scope scope = Scope.valueOf(extLayoutAttribute.getScope().name());
        final LayoutAttributeDescriptorImpl layoutAttributeDescriptor = new LayoutAttributeDescriptorImpl(name, scope);
        layoutAttributeDescriptor.setDefaultValue(extLayoutAttribute.getDefaultValue());
        layoutAttributeDescriptor.setDescription(extLayoutAttribute.getDescription());
        layoutAttributeDescriptor.setTargetElementNames(new LinkedHashSet<String>(extLayoutAttribute.getTargetElements()));
        layoutAttributeDescriptors.add(layoutAttributeDescriptor);
    }
    stylesheetDescriptor.setLayoutAttributeDescriptors(layoutAttributeDescriptors);
    this.stylesheetDescriptorDao.updateStylesheetDescriptor(stylesheetDescriptor);
}

Example 2 with IOutputPropertyDescriptor

use of org.apereo.portal.layout.om.IOutputPropertyDescriptor in project uPortal by Jasig.

the class StylesheetUserPreferencesServiceImpl method removeOutputProperty.

@Transactional
@Override
public String removeOutputProperty(HttpServletRequest request, PreferencesScope prefScope, String name) {
    final StylesheetPreferencesKey stylesheetPreferencesKey = this.getStylesheetPreferencesKey(request, prefScope);
    final IStylesheetDescriptor stylesheetDescriptor = stylesheetPreferencesKey.stylesheetDescriptor;
    final IOutputPropertyDescriptor outputPropertyDescriptor = stylesheetDescriptor.getOutputPropertyDescriptor(name);
    if (outputPropertyDescriptor == null) {
        logger.warn("Attempted to remove output property '{}' but no such output property is defined in stylesheet descriptor '{}'. It will be ignored", new Object[] { name, stylesheetDescriptor.getName() });
        return null;
    }
    final Scope scope = this.getWriteScope(request, prefScope, stylesheetPreferencesKey, outputPropertyDescriptor);
    switch(scope) {
        case PERSISTENT:
            {
                final IStylesheetUserPreferences stylesheetUserPreferences = this.getStylesheetUserPreferences(request, stylesheetPreferencesKey);
                if (stylesheetUserPreferences == null) {
                    return null;
                }
                final String oldValue = stylesheetUserPreferences.removeOutputProperty(name);
                this.stylesheetUserPreferencesDao.storeStylesheetUserPreferences(stylesheetUserPreferences);
                this.clearStylesheetUserPreferencesCache(request, stylesheetPreferencesKey);
                return oldValue;
            }
        default:
            {
                return removeDataValue(request, stylesheetPreferencesKey, scope, OUTPUT_PROPERTIES_KEY, name);
            }
    }
}

Example 3 with IOutputPropertyDescriptor

use of org.apereo.portal.layout.om.IOutputPropertyDescriptor in project uPortal by Jasig.

the class StylesheetUserPreferencesServiceImplTest method testThemeStylesheetUserPreferences.

/** @throws Exception */
@Test
public void testThemeStylesheetUserPreferences() throws Exception {
    //Setup mocks
    final HttpServletRequest request = new MockHttpServletRequest();
    //initialize the session
    request.getSession();
    final IStylesheetDescriptorDao stylesheetDescriptorDao = mock(IStylesheetDescriptorDao.class);
    final IUserInstanceManager userInstanceManager = mock(IUserInstanceManager.class);
    final IStylesheetUserPreferencesDao stylesheetUserPreferencesDao = mock(IStylesheetUserPreferencesDao.class);
    final IFragmentDefinitionUtils fragmentUtils = mock(IFragmentDefinitionUtils.class);
    final IUserInstance userInstance = mock(IUserInstance.class);
    when(userInstanceManager.getUserInstance(request)).thenReturn(userInstance);
    final IPerson person = mock(IPerson.class);
    when(userInstance.getPerson()).thenReturn(person);
    final IUserPreferencesManager preferencesManager = mock(IUserPreferencesManager.class);
    when(userInstance.getPreferencesManager()).thenReturn(preferencesManager);
    final IUserProfile userProfile = mock(IUserProfile.class);
    when(preferencesManager.getUserProfile()).thenReturn(userProfile);
    final IUserLayoutManager userLayoutManager = mock(IUserLayoutManager.class);
    when(preferencesManager.getUserLayoutManager()).thenReturn(userLayoutManager);
    final IUserLayout userLayout = mock(IUserLayout.class);
    when(userLayoutManager.getUserLayout()).thenReturn(userLayout);
    when(userProfile.getThemeStylesheetId()).thenReturn(1);
    final IStylesheetDescriptor stylesheetDescriptor = mock(IStylesheetDescriptor.class);
    when(stylesheetDescriptorDao.getStylesheetDescriptor(1)).thenReturn(stylesheetDescriptor);
    final ILayoutAttributeDescriptor skinLayoutAttributeDescriptor = mock(ILayoutAttributeDescriptor.class);
    when(stylesheetDescriptor.getLayoutAttributeDescriptor("minimized")).thenReturn(skinLayoutAttributeDescriptor);
    when(skinLayoutAttributeDescriptor.getName()).thenReturn("minimized");
    when(skinLayoutAttributeDescriptor.getScope()).thenReturn(Scope.REQUEST);
    when(skinLayoutAttributeDescriptor.getTargetElementNames()).thenReturn(Collections.singleton("folder"));
    final IOutputPropertyDescriptor mediaOutputPropertyDescriptor = mock(IOutputPropertyDescriptor.class);
    when(stylesheetDescriptor.getOutputPropertyDescriptor("media")).thenReturn(mediaOutputPropertyDescriptor);
    when(mediaOutputPropertyDescriptor.getName()).thenReturn("media");
    when(mediaOutputPropertyDescriptor.getScope()).thenReturn(Scope.SESSION);
    final IStylesheetParameterDescriptor skinStylesheetParameterDescriptor = mock(IStylesheetParameterDescriptor.class);
    when(stylesheetDescriptor.getStylesheetParameterDescriptor("skin")).thenReturn(skinStylesheetParameterDescriptor);
    when(skinStylesheetParameterDescriptor.getName()).thenReturn("media");
    when(skinStylesheetParameterDescriptor.getScope()).thenReturn(Scope.PERSISTENT);
    final IStylesheetUserPreferences persistentStylesheetUserPreferences = mock(IStylesheetUserPreferences.class);
    when(stylesheetUserPreferencesDao.createStylesheetUserPreferences(stylesheetDescriptor, person, userProfile)).thenReturn(persistentStylesheetUserPreferences);
    when(stylesheetUserPreferencesDao.getStylesheetUserPreferences(stylesheetDescriptor, person, userProfile)).thenReturn(persistentStylesheetUserPreferences);
    when(persistentStylesheetUserPreferences.getStylesheetParameter("skin")).thenReturn(null).thenReturn("red");
    //Create and initialize service bean
    final StylesheetUserPreferencesServiceImpl stylesheetUserPreferencesService = new StylesheetUserPreferencesServiceImpl();
    stylesheetUserPreferencesService.setStylesheetDescriptorDao(stylesheetDescriptorDao);
    stylesheetUserPreferencesService.setUserInstanceManager(userInstanceManager);
    stylesheetUserPreferencesService.setStylesheetUserPreferencesDao(stylesheetUserPreferencesDao);
    stylesheetUserPreferencesService.setFragmentDefinitionUtils(fragmentUtils);
    //Run test
    String actual;
    actual = stylesheetUserPreferencesService.getLayoutAttribute(request, PreferencesScope.THEME, "u1l1n1", "minimized");
    assertNull(actual);
    actual = stylesheetUserPreferencesService.setLayoutAttribute(request, PreferencesScope.THEME, "u1l1n1", "minimized", "true");
    assertNull(actual);
    actual = stylesheetUserPreferencesService.getLayoutAttribute(request, PreferencesScope.THEME, "u1l1n1", "minimized");
    assertEquals("true", actual);
    actual = stylesheetUserPreferencesService.getStylesheetParameter(request, PreferencesScope.THEME, "skin");
    assertNull(actual);
    actual = stylesheetUserPreferencesService.setStylesheetParameter(request, PreferencesScope.THEME, "skin", "red");
    verify(persistentStylesheetUserPreferences).setStylesheetParameter("skin", "red");
    assertNull(actual);
    actual = stylesheetUserPreferencesService.getStylesheetParameter(request, PreferencesScope.THEME, "skin");
    assertEquals("red", actual);
}

Example 4 with IOutputPropertyDescriptor

use of org.apereo.portal.layout.om.IOutputPropertyDescriptor in project uPortal by Jasig.

the class StylesheetDescriptorImporterExporter method convert.

/**
     * Convert the {@link IStylesheetDescriptor} to an {@link ExternalStylesheetDescriptor}.
     *
     * @param stylesheetDescriptor
     * @return converted object, never null
     */
protected ExternalStylesheetDescriptor convert(IStylesheetDescriptor stylesheetDescriptor) {
    final ExternalStylesheetDescriptor externalStylesheetDescriptor = new ExternalStylesheetDescriptor();
    externalStylesheetDescriptor.setName(stylesheetDescriptor.getName());
    externalStylesheetDescriptor.setUrlSyntaxHelper(stylesheetDescriptor.getUrlNodeSyntaxHelperName());
    externalStylesheetDescriptor.setDescription(stylesheetDescriptor.getDescription());
    externalStylesheetDescriptor.setUri(stylesheetDescriptor.getStylesheetResource());
    final Collection<IOutputPropertyDescriptor> outputPropertyDescriptors = stylesheetDescriptor.getOutputPropertyDescriptors();
    final List<ExternalOutputPropertyDescriptor> extOutputPropertyDescriptors = externalStylesheetDescriptor.getOutputProperties();
    for (final IOutputPropertyDescriptor outputPropertyDescriptor : outputPropertyDescriptors) {
        final ExternalOutputPropertyDescriptor extOutputPropertyDescriptor = new ExternalOutputPropertyDescriptor();
        copyProperties(outputPropertyDescriptor, extOutputPropertyDescriptor);
        extOutputPropertyDescriptors.add(extOutputPropertyDescriptor);
    }
    Collections.sort(extOutputPropertyDescriptors, ExternalStylesheetDataNameComparator.INSTANCE);
    final Collection<IStylesheetParameterDescriptor> stylesheetParameterDescriptors = stylesheetDescriptor.getStylesheetParameterDescriptors();
    final List<ExternalStylesheetParameterDescriptor> extStylesheetParameterDescriptors = externalStylesheetDescriptor.getStylesheetParameters();
    for (final IStylesheetParameterDescriptor stylesheetParameterDescriptor : stylesheetParameterDescriptors) {
        final ExternalStylesheetParameterDescriptor extStylesheetParameterDescriptor = new ExternalStylesheetParameterDescriptor();
        copyProperties(stylesheetParameterDescriptor, extStylesheetParameterDescriptor);
        extStylesheetParameterDescriptors.add(extStylesheetParameterDescriptor);
    }
    Collections.sort(extStylesheetParameterDescriptors, ExternalStylesheetDataNameComparator.INSTANCE);
    final Collection<ILayoutAttributeDescriptor> layoutAttributeDescriptors = stylesheetDescriptor.getLayoutAttributeDescriptors();
    final List<ExternalLayoutAttributeDescriptor> extLayoutAttributeDescriptors = externalStylesheetDescriptor.getLayoutAttributes();
    for (final ILayoutAttributeDescriptor layoutAttributeDescriptor : layoutAttributeDescriptors) {
        final ExternalLayoutAttributeDescriptor extLayoutAttributeDescriptor = new ExternalLayoutAttributeDescriptor();
        copyProperties(layoutAttributeDescriptor, extLayoutAttributeDescriptor);
        extLayoutAttributeDescriptor.getTargetElements().addAll(layoutAttributeDescriptor.getTargetElementNames());
        extLayoutAttributeDescriptors.add(extLayoutAttributeDescriptor);
    }
    Collections.sort(extLayoutAttributeDescriptors, ExternalStylesheetDataNameComparator.INSTANCE);
    return externalStylesheetDescriptor;
}

Example 5 with IOutputPropertyDescriptor

use of org.apereo.portal.layout.om.IOutputPropertyDescriptor in project uPortal by Jasig.

the class StylesheetUserPreferencesServiceImpl method populateOutputProperties.

@Override
public <P extends Populator<String, String>> P populateOutputProperties(HttpServletRequest request, PreferencesScope prefScope, P properties) {
    final StylesheetPreferencesKey stylesheetPreferencesKey = this.getStylesheetPreferencesKey(request, prefScope);
    final IStylesheetDescriptor stylesheetDescriptor = stylesheetPreferencesKey.stylesheetDescriptor;
    //Get the scoped sources once
    final IStylesheetUserPreferences stylesheetUserPreferences = this.getStylesheetUserPreferences(request, stylesheetPreferencesKey);
    final Map<String, String> sessionOutputProperties;
    final HttpSession session = request.getSession(false);
    if (session == null) {
        sessionOutputProperties = null;
    } else {
        sessionOutputProperties = PortalWebUtils.getMapSessionAttribute(session, OUTPUT_PROPERTIES_KEY + stylesheetPreferencesKey.toString(), false);
    }
    final Map<String, String> requestOutputProperties = PortalWebUtils.getMapRequestAttribute(request, OUTPUT_PROPERTIES_KEY + stylesheetPreferencesKey.toString(), false);
    //Try getting each output property to populate the Properties
    for (final IOutputPropertyDescriptor outputPropertyDescriptor : stylesheetDescriptor.getOutputPropertyDescriptors()) {
        final String name = outputPropertyDescriptor.getName();
        final String value;
        final Scope scope = outputPropertyDescriptor.getScope();
        switch(scope) {
            case PERSISTENT:
                {
                    if (stylesheetUserPreferences == null) {
                        value = null;
                        break;
                    }
                    value = stylesheetUserPreferences.getOutputProperty(name);
                    break;
                }
            case SESSION:
                {
                    if (sessionOutputProperties == null) {
                        value = null;
                        break;
                    }
                    value = sessionOutputProperties.get(name);
                    break;
                }
            case REQUEST:
                {
                    if (requestOutputProperties == null) {
                        value = null;
                        break;
                    }
                    value = requestOutputProperties.get(name);
                    break;
                }
            default:
                {
                    value = null;
                    break;
                }
        }
        //Don't add unset properties
        if (value == null) {
            continue;
        }
        //If the value is equal to the default value remove the property and return null
        if (this.compareValues(value, outputPropertyDescriptor.getDefaultValue())) {
            this.removeOutputProperty(request, prefScope, name);
            continue;
        }
        properties.put(name, value);
    }
    return properties;
}